home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / texinfo / elisp / texinfmt.el < prev    next >
Lisp/Scheme  |  1992-09-16  |  102KB  |  2,752 lines
  1. ;;;; texinfmt.el
  2.  
  3. ;;; Emacs lisp functions to convert Texinfo files to Info files.
  4.  
  5. (defvar texinfmt-version "2.26 of 15 September 1992")
  6.  
  7. ;;; Robert J. Chassell          
  8. ;;; Please send bug reports to:  bob@gnu.ai.mit.edu
  9.  
  10. ;;; Copyright (C) 1985, 1986, 1988,
  11. ;;;               1990, 1991, 1992  Free Software Foundation, Inc.
  12.  
  13.  
  14. ;;; This file is part of GNU Emacs.
  15.  
  16. ;; GNU Emacs is free software; you can redistribute it and/or modify
  17. ;; it under the terms of the GNU General Public License as published by
  18. ;; the Free Software Foundation; either version 2, or (at your option)
  19. ;; any later version.
  20.  
  21. ;; GNU Emacs is distributed in the hope that it will be useful,
  22. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  23. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24. ;; GNU General Public License for more details.
  25.  
  26. ;; You should have received a copy of the GNU General Public License
  27. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  28. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  29.  
  30.  
  31. ;;; Variable definitions
  32.  
  33. (require 'texinfo)              ; So `texinfo-footnote-style' is defined.
  34.  
  35. (defvar texinfo-format-syntax-table nil)
  36.  
  37. (defvar texinfo-vindex)
  38. (defvar texinfo-findex)
  39. (defvar texinfo-cindex)
  40. (defvar texinfo-pindex)
  41. (defvar texinfo-tindex)
  42. (defvar texinfo-kindex)
  43. (defvar texinfo-last-node)
  44. (defvar texinfo-node-names)
  45. (defvar texinfo-enclosure-list)
  46.  
  47.  
  48. ;;; Syntax table
  49.  
  50. (if texinfo-format-syntax-table
  51.     nil
  52.   (setq texinfo-format-syntax-table (make-syntax-table))
  53.   (modify-syntax-entry ?\" " " texinfo-format-syntax-table)
  54.   (modify-syntax-entry ?\\ " " texinfo-format-syntax-table)
  55.   (modify-syntax-entry ?@ "\\" texinfo-format-syntax-table)
  56.   (modify-syntax-entry ?\^q "\\" texinfo-format-syntax-table)
  57.   (modify-syntax-entry ?\[ "." texinfo-format-syntax-table)
  58.   (modify-syntax-entry ?\] "." texinfo-format-syntax-table)
  59.   (modify-syntax-entry ?\( "." texinfo-format-syntax-table)
  60.   (modify-syntax-entry ?\) "." texinfo-format-syntax-table)
  61.   (modify-syntax-entry ?{ "(}" texinfo-format-syntax-table)
  62.   (modify-syntax-entry ?} "){" texinfo-format-syntax-table)
  63.   (modify-syntax-entry ?\' "." texinfo-format-syntax-table))
  64.  
  65.  
  66. ;;; Top level buffer and region formatting functions
  67.  
  68. (defun texinfo-format-buffer (&optional notagify)
  69.   "Process the current buffer as texinfo code, into an Info file.
  70. The Info file output is generated in a buffer visiting the Info file
  71. names specified in the @setfilename command.
  72.  
  73. Non-nil argument (prefix, if interactive) means don't make tag table
  74. and don't split the file if large.  You can use Info-tagify and
  75. Info-split to do these manually."
  76.   (interactive "P")
  77.   (let ((lastmessage "Formatting Info file..."))
  78.     (message lastmessage)
  79.     (texinfo-format-buffer-1)
  80.     (if notagify
  81.         nil
  82.       (if (> (buffer-size) 30000)
  83.           (progn
  84.             (message (setq lastmessage "Making tags table for Info file..."))
  85.             (Info-tagify)))
  86.       (if (> (buffer-size) 100000)
  87.           (progn
  88.             (message (setq lastmessage "Splitting Info file..."))
  89.             (Info-split))))
  90.     (message (concat lastmessage
  91.                      (if (interactive-p) "done.  Now save it." "done.")))))
  92.  
  93. (defvar texinfo-region-buffer-name "*Info Region*"
  94.   "*Name of the temporary buffer used by \\[texinfo-format-region].")
  95.  
  96. (defun texinfo-format-region (region-beginning region-ending)
  97.   "Convert the current region of the Texinfo file to Info format.
  98. This lets you see what that part of the file will look like in Info.
  99. The command is bound to \\[texinfo-format-region].  The text that is
  100. converted to Info is stored in a temporary buffer."
  101.   (interactive "r")
  102.   (message "Converting region to Info format...")
  103.   (let (texinfo-command-start
  104.         texinfo-command-end
  105.         texinfo-command-name
  106.         texinfo-vindex
  107.         texinfo-findex
  108.         texinfo-cindex
  109.         texinfo-pindex
  110.         texinfo-tindex
  111.         texinfo-kindex
  112.         texinfo-stack
  113.         texinfo-format-filename
  114.         texinfo-example-start
  115.         texinfo-last-node-pos
  116.         texinfo-last-node
  117.         texinfo-node-names
  118.     (texinfo-footnote-number 0)
  119.         last-input-buffer
  120.         (fill-column-for-info fill-column)
  121.         (input-buffer (current-buffer))
  122.         (input-directory default-directory)
  123.         filename-or-header
  124.         filename-or-header-beginning
  125.         filename-or-header-end)
  126.     
  127. ;;; Find a buffer to use.
  128.     
  129.     (switch-to-buffer (get-buffer-create texinfo-region-buffer-name))
  130.     (erase-buffer)
  131.  
  132.     ;; Insert the region into the buffer.
  133.     
  134.     ;; First, find file name or tell of its absence.
  135.     ;; Second, insert lines between beginning and end of header lines, 
  136.     ;;    if any, or else insert the filename.
  137.     ;; Third, insert region.
  138.     
  139.     (save-excursion
  140.       (set-buffer input-buffer)
  141.       (save-excursion
  142.         (save-restriction
  143.           (widen)
  144.           (goto-char (point-min))
  145.           (let ((search-end (save-excursion (forward-line 100) (point))))
  146.             
  147.             ;; Find the filename or else explain that a filename is needed.
  148.             (or (search-forward "@setfilename" search-end t)
  149.                 (error
  150.                  "The texinfo file needs a line saying: @setfilename <name>"))
  151.             
  152.             ;; Find header and copy it into buffer; or copy just the 
  153.             ;;     filename if no header.
  154.             (goto-char (point-min))
  155.             (if (and 
  156.                  (prog1 
  157.                      (search-forward texinfo-start-of-header search-end t)
  158.                    (beginning-of-line)
  159.                    ;; Mark beginning of header.
  160.                    (setq filename-or-header-beginning (point)))
  161.                  (prog1 
  162.                      (search-forward texinfo-end-of-header nil t)
  163.                    (beginning-of-line)
  164.                    ;; Mark end of header
  165.                    (setq filename-or-header-end (point)))) 
  166.                 
  167.                 ;; Copy header  
  168.                 (setq filename-or-header 
  169.                       (buffer-substring
  170.                        (min filename-or-header-beginning region-beginning)
  171.                       filename-or-header-end))
  172.               ;; Else no header; insert @filename line in buffer
  173.               (goto-char (point-min))
  174.               (search-forward "@setfilename" search-end t)
  175.               (beginning-of-line)
  176.               (setq filename-or-header-beginning (point))
  177.               (forward-line 1)
  178.               (setq filename-or-header-end (point))
  179.               (setq filename-or-header 
  180.                     (buffer-substring 
  181.                      (min filename-or-header-beginning region-beginning)  
  182.                      filename-or-header-end)))))))
  183.     
  184.     ;; Insert the filename or header into the buffer.
  185.     (insert filename-or-header)
  186.     ;; Insert the region into the buffer.
  187.     (insert-buffer-substring
  188.      input-buffer
  189.      (max region-beginning filename-or-header-end)
  190.      region-ending)
  191.     ;; Make sure region ends in a newline.
  192.     (or (= (preceding-char) ?\n)
  193.         (insert "\n"))
  194.     
  195.     (texinfo-mode)
  196.     (setq fill-column fill-column-for-info)
  197.  
  198.     ;; Install a syntax table useful for scanning command operands.
  199.     (set-syntax-table texinfo-format-syntax-table)
  200.     ;; Append @refill to appropriate paragraphs
  201.     (goto-char (point-min))
  202.     (message "Converting region to Info format...")
  203.     (texinfo-append-refill)
  204.     ;; If the region includes the effective end of the data,
  205.     ;; discard everything after that.
  206.     (goto-char (point-max))
  207.     (if (re-search-backward "^@bye" nil t)
  208.         (delete-region (point) (point-max)))
  209.     ;; Make sure buffer ends in a newline.
  210.     (or (= (preceding-char) ?\n)
  211.         (insert "\n"))
  212.     ;; Don't use a previous value of texinfo-enclosure-list.
  213.     (setq texinfo-enclosure-list nil)
  214.  
  215.     ;; Now convert for real.
  216.     (goto-char (point-min))
  217.     (texinfo-format-scan)
  218.     (goto-char (point-min))
  219.     
  220.     (message "Done.")))
  221.  
  222.  
  223. ;;; Primary internal formatting function for the whole buffer.
  224.  
  225. (defun texinfo-format-buffer-1 ()
  226.   (let (texinfo-format-filename
  227.         texinfo-example-start
  228.         texinfo-command-start
  229.         texinfo-command-end
  230.         texinfo-command-name
  231.         texinfo-last-node
  232.         texinfo-last-node-pos
  233.         texinfo-vindex
  234.         texinfo-findex
  235.         texinfo-cindex
  236.         texinfo-pindex
  237.         texinfo-tindex
  238.         texinfo-kindex
  239.         texinfo-stack
  240.         texinfo-node-names
  241.     (texinfo-footnote-number 0)
  242.         last-input-buffer
  243.         outfile
  244.         (fill-column-for-info fill-column)
  245.         (input-buffer (current-buffer))
  246.         (input-directory default-directory))
  247.     (setq texinfo-enclosure-list nil)
  248.     (save-excursion
  249.       (goto-char (point-min))
  250.       (search-forward "@setfilename")
  251.       (setq texinfo-command-end (point))
  252.       (setq outfile (texinfo-parse-line-arg)))
  253.     (find-file outfile)
  254.     (texinfo-mode)
  255.     (setq fill-column fill-column-for-info)
  256.     (set-syntax-table texinfo-format-syntax-table)
  257.     (erase-buffer)
  258.     (insert-buffer-substring input-buffer)
  259.     ;; Append @refill to appropriate paragraphs
  260.     (goto-char (point-min))
  261.     (message "Converting %s to Info format..." (buffer-name input-buffer))
  262.     (texinfo-append-refill)
  263.     (goto-char (point-min))
  264.     (search-forward "@setfilename")
  265.     (beginning-of-line)
  266.     (delete-region (point-min) (point))
  267.     ;; Remove @bye at end of file, if it is there.
  268.     (goto-char (point-max))
  269.     (if (search-backward "@bye" nil t)
  270.         (delete-region (point) (point-max)))
  271.     ;; Make sure buffer ends in a newline.
  272.     (or (= (preceding-char) ?\n)
  273.         (insert "\n"))
  274.     ;; Scan the whole buffer, converting to Info format.
  275.     (texinfo-format-scan)
  276.     ;; Return data for indices.
  277.     (goto-char (point-min))
  278.     (list outfile
  279.           texinfo-vindex texinfo-findex texinfo-cindex
  280.           texinfo-pindex texinfo-tindex texinfo-kindex)))
  281.  
  282.  
  283. ;;; Perform non-@-command file conversions
  284.  
  285. (defun texinfo-format-convert (min max)
  286.   ;; Convert left and right quotes to typewriter font quotes.
  287.   (goto-char min)
  288.   (while (search-forward "``" max t)
  289.     (replace-match "\""))
  290.   (goto-char min)
  291.   (while (search-forward "''" max t)
  292.     (replace-match "\""))
  293.   ;; Convert three hyphens in a row to two.
  294.   (goto-char min)
  295.   (while (re-search-forward "\\( \\|\\w\\)\\(---\\)\\( \\|\\w\\)" max t)
  296.     (delete-region (1+ (match-beginning 2)) (+ 2 (match-beginning
  297.     2)))))
  298.  
  299. (defvar texinfo-no-refill-regexp
  300.   "^@\\(example\\|smallexample\\|lisp\\|smalllisp\\|display\\|format\\|flushleft\\|flushright\\|menu\\|titlepage\\|iftex\\|tex\\)"
  301.   "Regexp specifying environments in which paragraphs are not filled.")
  302.  
  303. (defvar texinfo-part-of-para-regexp
  304.   "^@\\(b{\\|bullet{\\|cite{\\|code{\\|emph{\\|equiv{\\|error{\\|expansion{\\|file{\\|i{\\|inforef{\\|kbd{\\|key{\\|lisp{\\|minus{\\|point{\\|print{\\|pxref{\\|r{\\|ref{\\|result{\\|samp{\\|sc{\\|t{\\|TeX{\\|today{\\|var{\\|w{\\|xref{\\)"
  305.   "Regexp specifying @-commands found within paragraphs.")
  306.  
  307. (defun texinfo-append-refill ()
  308.   "Append @refill at end of each paragraph that should be filled.
  309. Do not append @refill to paragraphs within @example and similar environments.  
  310. Do not append @refill to paragraphs containing @w{TEXT} or @*."
  311.  
  312.   ;; It is necessary to append @refill before other processing because
  313.   ;; the other processing removes information that tells Texinfo
  314.   ;; whether the text should or should not be filled.
  315.   
  316.   (while (< (point) (point-max))
  317.     (let ((refill-blank-lines "^[ \t\n]*$")
  318.           (case-fold-search nil))       ; Don't confuse @TeX and @tex....
  319.       (beginning-of-line)
  320.       ;; 1. Skip over blank lines;
  321.       ;;    skip over lines beginning with @-commands, 
  322.       ;;    but do not skip over lines
  323.       ;;      that are no-refill environments such as @example or
  324.       ;;      that begin with within-paragraph @-commands such as @code.
  325.       (while (and (looking-at (concat "^@\\|^\\\\\\|" refill-blank-lines))
  326.                   (not (looking-at 
  327.                         (concat
  328.                          "\\(" 
  329.                          texinfo-no-refill-regexp
  330.                          "\\|" 
  331.                          texinfo-part-of-para-regexp
  332.                          "\\)")))
  333.                   (< (point) (point-max)))
  334.         (forward-line 1))
  335.       ;; 2. Skip over @example and similar no-refill environments.
  336.       (if (looking-at texinfo-no-refill-regexp)
  337.           (let ((environment
  338.                  (buffer-substring (match-beginning 1) (match-end 1))))
  339.             (progn (re-search-forward (concat "^@end " environment) nil t)
  340.                    (forward-line 1)))
  341.         ;; 3. Do not refill a paragraph containing @w or @*
  342.         (if  (or
  343.               (>= (point) (point-max))
  344.               (re-search-forward
  345.                "@w{\\|@\\*" (save-excursion (forward-paragraph) (point)) t))
  346.             ;; Go to end of paragraph and do nothing.
  347.             (forward-paragraph) 
  348.           ;; 4. Else go to end of paragraph and insert @refill
  349.           (forward-paragraph)
  350.           (forward-line -1)
  351.           (end-of-line)
  352.           (delete-region
  353.            (point)
  354.            (save-excursion (skip-chars-backward " \t") (point)))
  355.           ;; `looking-at-backward' not available in v. 18.57
  356.           ;; (if (not (looking-at-backward "@refill\\|@bye")) ;)
  357.           (if (not (re-search-backward
  358.                     "@refill\\|@bye"
  359.                     (save-excursion (beginning-of-line) (point))
  360.                     t))
  361.               (insert "@refill"))
  362.           (forward-line 1))))))
  363.  
  364.  
  365. ;;; Perform those texinfo-to-info conversions that apply to the whole input
  366. ;;; uniformly.
  367.  
  368. (defun texinfo-format-scan ()
  369.   (texinfo-format-convert (point-min) (point-max))
  370.   ;; Scan for @-commands.
  371.   (goto-char (point-min))
  372.   (while (search-forward "@" nil t)
  373.     (if (looking-at "[@{}'` *]")
  374.         ;; Handle a few special @-followed-by-one-char commands.
  375.         (if (= (following-char) ?*)
  376.             (progn
  377.               ;; remove command
  378.               (delete-region (1- (point)) (1+ (point)))
  379.               ;; insert return if not at end of line;
  380.               ;; else line is already broken.
  381.               (if (not (= (following-char) ?\n))
  382.                   (insert ?\n)))      
  383.           ;; The other characters are simply quoted.  Delete the @.
  384.           (delete-char -1)
  385.           (forward-char 1))
  386.       ;; @ is followed by a command-word; find the end of the word.
  387.       (setq texinfo-command-start (1- (point)))
  388.       (if (= (char-syntax (following-char)) ?w)
  389.           (forward-word 1)
  390.         (forward-char 1))
  391.       (setq texinfo-command-end (point))
  392.       ;; Call the handler for this command.
  393.       (setq texinfo-command-name
  394.             (intern (buffer-substring
  395.              (1+ texinfo-command-start) texinfo-command-end)))
  396.       (let ((enclosure-type
  397.              (assoc
  398.               (symbol-name texinfo-command-name)
  399.               texinfo-enclosure-list)))
  400.         (if enclosure-type
  401.             (progn
  402.               (insert
  403.                (car (car (cdr enclosure-type))) 
  404.                (texinfo-parse-arg-discard)
  405.                (car (cdr (car (cdr enclosure-type)))))
  406.               (goto-char texinfo-command-start))
  407.           (let ((cmd (get texinfo-command-name 'texinfo-format)))
  408.             (if cmd (funcall cmd) (texinfo-unsupported)))))))
  409.   
  410.   (cond (texinfo-stack
  411.          (goto-char (nth 2 (car texinfo-stack)))
  412.          (error "Unterminated @%s" (car (car texinfo-stack))))))
  413.  
  414. (put 'begin 'texinfo-format 'texinfo-format-begin)
  415. (defun texinfo-format-begin ()
  416.   (texinfo-format-begin-end 'texinfo-format))
  417.  
  418. (put 'end 'texinfo-format 'texinfo-format-end)
  419. (defun texinfo-format-end ()
  420.   (texinfo-format-begin-end 'texinfo-end))
  421.  
  422. (defun texinfo-format-begin-end (prop)
  423.   (setq texinfo-command-name (intern (texinfo-parse-line-arg)))
  424.   (setq cmd (get texinfo-command-name prop))
  425.   (if cmd (funcall cmd)
  426.     (texinfo-unsupported)))
  427.  
  428. ;;; Parsing functions
  429.  
  430. (defun texinfo-parse-line-arg ()
  431.   (goto-char texinfo-command-end)
  432.   (let ((start (point)))
  433.     (cond ((looking-at " ")
  434.        (skip-chars-forward " ")
  435.        (setq start (point))
  436.        (end-of-line)
  437.            (skip-chars-backward " ")
  438.            (delete-region (point) (progn (end-of-line) (point)))
  439.        (setq texinfo-command-end (1+ (point))))
  440.       ((looking-at "{")
  441.        (setq start (1+ (point)))
  442.        (forward-list 1)
  443.        (setq texinfo-command-end (point))
  444.        (forward-char -1))
  445.       (t
  446.        (error "Invalid texinfo command arg format")))
  447.     (prog1 (buffer-substring start (point))
  448.        (if (eolp) (forward-char 1)))))
  449.  
  450. (defun texinfo-parse-expanded-arg ()
  451.   (goto-char texinfo-command-end)
  452.   (let ((start (point))
  453.     marker)
  454.     (cond ((looking-at " ")
  455.        (skip-chars-forward " ")
  456.        (setq start (point))
  457.        (end-of-line)
  458.        (setq texinfo-command-end (1+ (point))))
  459.       ((looking-at "{")
  460.        (setq start (1+ (point)))
  461.        (forward-list 1)
  462.        (setq texinfo-command-end (point))
  463.        (forward-char -1))
  464.       (t
  465.        (error "Invalid texinfo command arg format")))
  466.     (setq marker (move-marker (make-marker) texinfo-command-end))
  467.     (texinfo-format-expand-region start (point))
  468.     (setq texinfo-command-end (marker-position marker))
  469.     (move-marker marker nil)
  470.     (prog1 (buffer-substring start (point))
  471.        (if (eolp) (forward-char 1)))))
  472.  
  473. (defun texinfo-format-expand-region (start end)
  474.   (save-restriction
  475.     (narrow-to-region start end)
  476.     (let (texinfo-command-start
  477.       texinfo-command-end
  478.       texinfo-command-name
  479.       texinfo-stack)
  480.       (texinfo-format-scan))
  481.     (goto-char (point-max))))
  482.  
  483. (defun texinfo-parse-arg-discard ()
  484.   (prog1 (texinfo-parse-line-arg)
  485.      (texinfo-discard-command)))
  486.  
  487. (defun texinfo-discard-command ()
  488.   (delete-region texinfo-command-start texinfo-command-end))
  489.  
  490. (defun texinfo-optional-braces-discard ()
  491.   "Discard braces following command, if any."
  492.   (goto-char texinfo-command-end)
  493.   (let ((start (point)))
  494.     (cond ((looking-at "[ \t]*\n"))     ; do nothing
  495.           ((looking-at "{")             ; remove braces, if any
  496.        (forward-list 1)
  497.        (setq texinfo-command-end (point)))
  498.       (t
  499.            (error
  500.             "Invalid `texinfo-optional-braces-discard' format \(need braces?\)")))
  501.     (delete-region texinfo-command-start texinfo-command-end)))
  502.  
  503. (defun texinfo-format-parse-line-args ()
  504.   (let ((start (1- (point)))
  505.     next beg end
  506.     args)
  507.     (skip-chars-forward " ")
  508.     (while (not (eolp))
  509.       (setq beg (point))
  510.       (re-search-forward "[\n,]")
  511.       (setq next (point))
  512.       (if (bolp) (setq next (1- next)))
  513.       (forward-char -1)
  514.       (skip-chars-backward " ")
  515.       (setq end (point))
  516.       (setq args (cons (if (> end beg) (buffer-substring beg end))
  517.                args))
  518.       (goto-char next)
  519.       (skip-chars-forward " "))
  520.     (if (eolp) (forward-char 1))
  521.     (setq texinfo-command-end (point))
  522.     (nreverse args)))
  523.  
  524. (defun texinfo-format-parse-args ()
  525.   (let ((start (1- (point)))
  526.     next beg end
  527.     args)
  528.     (search-forward "{")
  529.     (save-excursion
  530.       (texinfo-format-expand-region 
  531.        (point)
  532.        (save-excursion (up-list 1) (1- (point)))))
  533.     ;; The following does not handle cross references of the form:
  534.     ;; `@xref{bullet, , @code{@@bullet}@{@}}.' because the
  535.     ;; re-search-forward finds the first right brace after the second
  536.     ;; comma. 
  537.     (while (/= (preceding-char) ?\})
  538.       (skip-chars-forward " \t\n")
  539.       (setq beg (point))
  540.       (re-search-forward "[},]")
  541.       (setq next (point))
  542.       (forward-char -1)
  543.       (skip-chars-backward " \t\n")
  544.       (setq end (point))
  545.       (cond ((< beg end)
  546.          (goto-char beg)
  547.          (while (search-forward "\n" end t)
  548.            (replace-match " "))))
  549.       (setq args (cons (if (> end beg) (buffer-substring beg end))
  550.                args))
  551.       (goto-char next))
  552.     (if (eolp) (forward-char 1))
  553.     (setq texinfo-command-end (point))
  554.     (nreverse args)))
  555.  
  556. (defun texinfo-format-parse-defun-args ()
  557.   (goto-char texinfo-command-end)
  558.   (let ((start (point)))
  559.     (end-of-line)
  560.     (setq texinfo-command-end (1+ (point)))
  561.     (let ((marker (move-marker (make-marker) texinfo-command-end)))
  562.       (texinfo-format-expand-region start (point))
  563.       (setq texinfo-command-end (marker-position marker))
  564.       (move-marker marker nil))
  565.     (goto-char start)
  566.     (let ((args '())
  567.       beg end)
  568.       (skip-chars-forward " ")
  569.       (while (not (eolp))
  570.     (cond ((looking-at "{")
  571.            (setq beg (1+ (point)))
  572.            (forward-list 1)
  573.            (setq end (1- (point))))
  574.           (t
  575.            (setq beg (point))
  576.            (re-search-forward "[\n ]")
  577.            (forward-char -1)
  578.            (setq end (point))))
  579.     (setq args (cons (buffer-substring beg end) args))
  580.     (skip-chars-forward " "))
  581.       (forward-char 1)
  582.       (nreverse args))))
  583.  
  584. (defun texinfo-discard-line ()
  585.   (goto-char texinfo-command-end)
  586.   (skip-chars-forward " \t")
  587.   (or (eolp)
  588.       (error "Extraneous text at end of command line."))
  589.   (goto-char texinfo-command-start)
  590.   (or (bolp)
  591.       (error "Extraneous text at beginning of command line."))
  592.   (delete-region (point) (progn (forward-line 1) (point))))
  593.  
  594. (defun texinfo-discard-line-with-args ()
  595.   (goto-char texinfo-command-start)
  596.   (delete-region (point) (progn (forward-line 1) (point))))
  597.  
  598.  
  599. ;;; @setfilename
  600.  
  601. ; 19 October 1990
  602. ; @setfilename modifed to work with include files; see @include
  603. ; (defun texinfo-format-setfilename ()
  604. ;   (let ((arg (texinfo-parse-arg-discard)))
  605. ;     (setq texinfo-format-filename
  606. ;       (file-name-nondirectory (expand-file-name arg)))
  607. ;     (insert "Info file: "
  608. ;         texinfo-format-filename ",    -*-Text-*-\n"
  609. ;         "produced by texinfo-format-buffer\nfrom "
  610. ;         (if (buffer-file-name input-buffer)
  611. ;         (concat "file: "
  612. ;             (file-name-sans-versions
  613. ;              (file-name-nondirectory
  614. ;               (buffer-file-name input-buffer))))
  615. ;           (concat "buffer " (buffer-name input-buffer)))
  616. ;         "\n\n")))
  617.  
  618. (put 'setfilename 'texinfo-format 'texinfo-format-setfilename)
  619. (defun texinfo-format-setfilename ()
  620.   (let ((arg (texinfo-parse-arg-discard)))
  621.     (if (eq input-buffer last-input-buffer)
  622.     nil                ; only use first setfilename in buffer
  623.       (message "Formatting Info file: %s" arg)
  624.       (setq texinfo-format-filename
  625.         (file-name-nondirectory (expand-file-name arg)))
  626.       (insert "Info file: "
  627.           texinfo-format-filename ",    -*-Text-*-\n"
  628.  
  629.           "produced on "
  630.               (substring (current-time-string) 8 10) " "
  631.               (substring (current-time-string) 4 7) " "
  632.               (substring (current-time-string) -4) 
  633.               " by texinfo-format-buffer"
  634.               "\nfrom "
  635.           (if (buffer-file-name input-buffer)
  636.           (concat "file `"
  637.               (file-name-sans-versions
  638.                (file-name-nondirectory
  639.                 (buffer-file-name input-buffer)))
  640.                           "'")
  641.         (concat "buffer `" (buffer-name input-buffer) "'"))
  642.               "\nusing `texinfmt.el' version "
  643.               texinfmt-version
  644.           ".\n\n"))))
  645.  
  646. ;;; @node, @menu
  647.  
  648. (put 'node 'texinfo-format 'texinfo-format-node)
  649. (defun texinfo-format-node ()
  650.   (let* ((args (texinfo-format-parse-line-args))
  651.      (name (nth 0 args))
  652.      (next (nth 1 args))
  653.      (prev (nth 2 args))
  654.      (up (nth 3 args)))
  655.     (texinfo-discard-command)
  656.     (setq texinfo-last-node name)
  657.     (let ((tem (downcase name)))
  658.       (if (assoc tem texinfo-node-names)
  659.       (error "Duplicate node name: %s" name)
  660.     (setq texinfo-node-names (cons (list tem) texinfo-node-names))))
  661.     (setq texinfo-footnote-number 0)
  662.     (or (bolp)
  663.     (insert ?\n))
  664.     (insert "\^_\nFile: " texinfo-format-filename
  665.         ", Node: " name)
  666.     (if next
  667.     (insert ", Next: " next))
  668.     (if prev
  669.     (insert ", Prev: " prev))
  670.     (if up
  671.     (insert ", Up: " up))
  672.     (insert ?\n)
  673.     (setq texinfo-last-node-pos (point))))
  674.  
  675. (put 'menu 'texinfo-format 'texinfo-format-menu)
  676. (defun texinfo-format-menu ()
  677.   (texinfo-discard-line)
  678.   (insert "* Menu:\n\n"))
  679.  
  680. (put 'menu 'texinfo-end 'texinfo-discard-command)
  681.  
  682.  
  683. ;;; Cross references
  684.  
  685. ; @xref {NODE, FNAME, NAME, FILE, DOCUMENT}
  686. ; -> *Note FNAME: (FILE)NODE
  687. ;   If FILE is missing,
  688. ;    *Note FNAME: NODE
  689. ;   If FNAME is empty and NAME is present
  690. ;    *Note NAME: Node
  691. ;   If both NAME and FNAME are missing
  692. ;    *Note NODE::
  693. ;   texinfo ignores the DOCUMENT argument.
  694. ; -> See section <xref to NODE> [NAME, else NODE], page <xref to NODE>
  695. ;   If FILE is specified, (FILE)NODE is used for xrefs.
  696. ;   If fifth argument DOCUMENT is specified, produces
  697. ;    See section <xref to NODE> [NAME, else NODE], page <xref to NODE>
  698. ;    of DOCUMENT
  699.  
  700. ; @ref             a reference that does not put `See' or `see' in
  701. ;                  the hardcopy and is the same as @xref in Info
  702. (put 'ref 'texinfo-format 'texinfo-format-xref)
  703.  
  704. (put 'xref 'texinfo-format 'texinfo-format-xref)
  705. (defun texinfo-format-xref ()
  706.   (let ((args (texinfo-format-parse-args)))
  707.     (texinfo-discard-command)
  708.     (insert "*Note ")
  709.     (let ((fname (or (nth 1 args) (nth 2 args))))
  710.       (if (null (or fname (nth 3 args)))
  711.       (insert (car args) "::")
  712.     (insert (or fname (car args)) ": ")
  713.     (if (nth 3 args)
  714.         (insert "(" (nth 3 args) ")"))
  715.     (insert (car args))))))
  716.  
  717. (put 'pxref 'texinfo-format 'texinfo-format-pxref)
  718. (defun texinfo-format-pxref ()
  719.   (texinfo-format-xref)
  720.   (or (save-excursion
  721.     (forward-char -2)
  722.     (looking-at "::"))
  723.       (insert ".")))
  724.  
  725. ;@inforef{NODE, FNAME, FILE}
  726. ;Like @xref{NODE, FNAME,,FILE} in texinfo.
  727. ;In Tex, generates "See Info file FILE, node NODE"
  728. (put 'inforef 'texinfo-format 'texinfo-format-inforef)
  729. (defun texinfo-format-inforef ()
  730.   (let ((args (texinfo-format-parse-args)))
  731.     (texinfo-discard-command)
  732.     (if (nth 1 args)
  733.         (insert "*Note " (nth 1 args) ": (" (nth 2 args) ")" (car args))
  734.       (insert "*Note " "(" (nth 2 args) ")" (car args) "::"))))
  735.  
  736.  
  737. ;;; Section headings
  738.  
  739. (put 'majorheading 'texinfo-format 'texinfo-format-chapter)
  740. (put 'chapheading 'texinfo-format 'texinfo-format-chapter)
  741. (put 'ichapter 'texinfo-format 'texinfo-format-chapter)
  742. (put 'chapter 'texinfo-format 'texinfo-format-chapter)
  743. (put 'iappendix 'texinfo-format 'texinfo-format-chapter)
  744. (put 'appendix 'texinfo-format 'texinfo-format-chapter)
  745. (put 'iunnumbered 'texinfo-format 'texinfo-format-chapter)
  746. (put 'top 'texinfo-format 'texinfo-format-chapter)
  747. (put 'unnumbered 'texinfo-format 'texinfo-format-chapter)
  748. (defun texinfo-format-chapter ()
  749.   (texinfo-format-chapter-1 ?*))
  750.  
  751. (put 'heading 'texinfo-format 'texinfo-format-section)
  752. (put 'isection 'texinfo-format 'texinfo-format-section)
  753. (put 'section 'texinfo-format 'texinfo-format-section)
  754. (put 'iappendixsection 'texinfo-format 'texinfo-format-section)
  755. (put 'appendixsection 'texinfo-format 'texinfo-format-section)
  756. (put 'iappendixsec 'texinfo-format 'texinfo-format-section)
  757. (put 'appendixsec 'texinfo-format 'texinfo-format-section)
  758. (put 'iunnumberedsec 'texinfo-format 'texinfo-format-section)
  759. (put 'unnumberedsec 'texinfo-format 'texinfo-format-section)
  760. (defun texinfo-format-section ()
  761.   (texinfo-format-chapter-1 ?=))
  762.  
  763. (put 'subheading 'texinfo-format 'texinfo-format-subsection)
  764. (put 'isubsection 'texinfo-format 'texinfo-format-subsection)
  765. (put 'subsection 'texinfo-format 'texinfo-format-subsection)
  766. (put 'iappendixsubsec 'texinfo-format 'texinfo-format-subsection)
  767. (put 'appendixsubsec 'texinfo-format 'texinfo-format-subsection)
  768. (put 'iunnumberedsubsec 'texinfo-format 'texinfo-format-subsection)
  769. (put 'unnumberedsubsec 'texinfo-format 'texinfo-format-subsection)
  770. (defun texinfo-format-subsection ()
  771.   (texinfo-format-chapter-1 ?-))
  772.  
  773. (put 'subsubheading 'texinfo-format 'texinfo-format-subsubsection)
  774. (put 'isubsubsection 'texinfo-format 'texinfo-format-subsubsection)
  775. (put 'subsubsection 'texinfo-format 'texinfo-format-subsubsection)
  776. (put 'iappendixsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  777. (put 'appendixsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  778. (put 'iunnumberedsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  779. (put 'unnumberedsubsubsec 'texinfo-format 'texinfo-format-subsubsection)
  780. (defun texinfo-format-subsubsection ()
  781.   (texinfo-format-chapter-1 ?.))
  782.  
  783. (defun texinfo-format-chapter-1 (belowchar)
  784.   (let ((arg (texinfo-parse-arg-discard)))
  785.     (message "Formatting: %s ... " arg)   ; So we can see where we are.
  786.     (insert ?\n arg ?\n "@SectionPAD " belowchar ?\n)
  787.     (forward-line -2)))
  788.  
  789. (put 'SectionPAD 'texinfo-format 'texinfo-format-sectionpad)
  790. (defun texinfo-format-sectionpad ()
  791.   (let ((str (texinfo-parse-arg-discard)))
  792.     (forward-char -1)
  793.     (let ((column (current-column)))
  794.       (forward-char 1)
  795.       (while (> column 0)
  796.     (insert str)
  797.     (setq column (1- column))))
  798.     (insert ?\n)))
  799.  
  800.  
  801. ;;; Space controling commands:  @. and @:   
  802. (put '\. 'texinfo-format 'texinfo-format-\.)
  803. (defun texinfo-format-\. ()
  804.   (texinfo-discard-command)
  805.   (insert "."))
  806.  
  807. (put '\: 'texinfo-format 'texinfo-format-\:)
  808. (defun texinfo-format-\: ()
  809.   (texinfo-discard-command))
  810.  
  811.  
  812. ;;; @center, @sp, and @br
  813.  
  814. (put 'center 'texinfo-format 'texinfo-format-center)
  815. (defun texinfo-format-center ()
  816.   (let ((arg (texinfo-parse-expanded-arg)))
  817.     (texinfo-discard-command)
  818.     (insert arg)
  819.     (insert ?\n)
  820.     (save-restriction
  821.       (goto-char (1- (point)))
  822.       (let ((indent-tabs-mode nil))
  823.     (center-line)))))
  824.  
  825. (put 'sp 'texinfo-format 'texinfo-format-sp)
  826. (defun texinfo-format-sp ()
  827.   (let* ((arg (texinfo-parse-arg-discard))
  828.      (num (read arg)))
  829.     (insert-char ?\n num)))
  830.  
  831. (put 'br 'texinfo-format 'texinfo-format-paragraph-break)
  832. (defun texinfo-format-paragraph-break ()
  833.   "Force a paragraph break.
  834. If used within a line, follow `@br' with braces."
  835.   (texinfo-optional-braces-discard)
  836.   ;; insert one return if at end of line;
  837.   ;; else insert two returns, to generate a blank line.
  838.   (if (= (following-char) ?\n)
  839.       (insert ?\n)
  840.     (insert-char ?\n 2)))
  841.  
  842.  
  843. ;;; @footnote  and  @footnotestyle
  844.  
  845. ; In Texinfo, footnotes are created with the `@footnote' command.
  846. ; This command is followed immediately by a left brace, then by the text of
  847. ; the footnote, and then by a terminating right brace.  The
  848. ; template for a footnote is:
  849. ; 
  850. ;      @footnote{TEXT}
  851. ;
  852. ; Info has two footnote styles:
  853. ; 
  854. ;    * In the End of node style, all the footnotes for a single node
  855. ;      are placed at the end of that node.  The footnotes are
  856. ;      separated from the rest of the node by a line of dashes with
  857. ;      the word `Footnotes' within it.
  858. ; 
  859. ;    * In the Separate node style, all the footnotes for a single node
  860. ;      are placed in an automatically constructed node of their own.
  861.  
  862. ; Footnote style is specified by the @footnotestyle command, either
  863. ;    @footnotestyle separate
  864. ; or
  865. ;    @footnotestyle end
  866. ; 
  867. ; The default is  separate
  868.  
  869. (defvar texinfo-footnote-style "separate" 
  870.   "Footnote style, either separate or end.")
  871.  
  872. (put 'footnotestyle 'texinfo-format 'texinfo-footnotestyle)
  873. (defun texinfo-footnotestyle ()
  874.   "Specify whether footnotes are at end of node or in separate nodes.
  875. Argument is either end or separate."
  876.   (setq texinfo-footnote-style (texinfo-parse-arg-discard)))
  877.  
  878. (defvar texinfo-footnote-number)
  879.  
  880. (put 'footnote 'texinfo-format 'texinfo-format-footnote)
  881. (defun texinfo-format-footnote ()
  882.   "Format a footnote in either end of node or separate node style.
  883. The   texinfo-footnote-style  variable controls which style is used."
  884.   (setq texinfo-footnote-number (1+ texinfo-footnote-number))
  885.   (cond ((string= texinfo-footnote-style "end")
  886.          (texinfo-format-end-node))
  887.         ((string= texinfo-footnote-style "separate")
  888.          (texinfo-format-separate-node))))
  889.  
  890. (defun texinfo-format-separate-node ()
  891.   "Format footnote in Separate node style, with notes in own node.
  892. The node is constructed automatically."
  893.   (let* (start
  894.          (arg (texinfo-parse-line-arg))
  895.          (node-name-beginning
  896.           (save-excursion
  897.             (re-search-backward
  898.              "^File: \\w+\\(\\w\\|\\s_\\|\\.\\|,\\)*[ \t]+Node:")
  899.             (match-end 0)))
  900.          (node-name
  901.           (save-excursion
  902.             (buffer-substring
  903.              (progn (goto-char node-name-beginning) ; skip over node command
  904.                     (skip-chars-forward " \t")  ; and over spaces
  905.                     (point))
  906.              (if (search-forward
  907.                   ","
  908.                   (save-excursion (end-of-line) (point)) t) ; bound search
  909.                  (1- (point))
  910.                (end-of-line) (point))))))
  911.     (texinfo-discard-command)  ; remove or insert whitespace, as needed
  912.     (delete-region (save-excursion (skip-chars-backward " \t\n") (point))
  913.                    (point))
  914.     (insert (format " (%d) (*Note %s-Footnotes::)"
  915.             texinfo-footnote-number node-name))
  916.     (fill-paragraph nil)
  917.     (save-excursion
  918.     (if (re-search-forward "^@node" nil 'move)
  919.         (forward-line -1))
  920.  
  921.     ;; two cases: for the first footnote, we must insert a node header;
  922.     ;; for the second and subsequent footnotes, we need only insert 
  923.     ;; the text of the  footnote.
  924.  
  925.     (if (save-excursion
  926.          (re-search-backward
  927.           (concat node-name "-Footnotes, Up: ")
  928.           node-name-beginning
  929.           t))
  930.         (progn   ; already at least one footnote
  931.           (setq start (point))
  932.           (insert (format "\n(%d)  %s\n" texinfo-footnote-number arg))
  933.           (fill-region start (point)))
  934.       ;; else not yet a footnote
  935.       (insert "\n\^_\nFile: "  texinfo-format-filename
  936.               "  Node: " node-name "-Footnotes, Up: " node-name "\n")
  937.       (setq start (point))
  938.       (insert (format "\n(%d)  %s\n" texinfo-footnote-number arg))
  939.       (fill-region start (point))))))
  940.  
  941. (defun texinfo-format-end-node ()
  942.   "Format footnote in the End of node style, with notes at end of node."
  943.   (let (start
  944.         (arg (texinfo-parse-line-arg)))
  945.     (texinfo-discard-command)  ; remove or insert whitespace, as needed
  946.     (delete-region (save-excursion (skip-chars-backward " \t\n") (point))
  947.                    (point))
  948.     (insert (format " (%d) " texinfo-footnote-number))
  949.     (fill-paragraph nil)
  950.     (save-excursion
  951.       (if (search-forward "\n--------- Footnotes ---------\n" nil t)
  952.           (progn ; already have footnote, put new one before end of node
  953.             (if (re-search-forward "^@node" nil 'move)
  954.                 (forward-line -1))
  955.             (setq start (point))
  956.             (insert (format "\n(%d)  %s\n" texinfo-footnote-number arg))
  957.             (fill-region start (point)))
  958.         ;; else no prior footnote
  959.         (if (re-search-forward "^@node" nil 'move)
  960.             (forward-line -1))
  961.         (insert "\n--------- Footnotes ---------\n")
  962.         (setq start (point))
  963.         (insert (format "\n(%d)  %s\n" texinfo-footnote-number arg))))))
  964.  
  965.  
  966. ;;; @itemize, @enumerate, and similar commands
  967.  
  968. ;; @itemize pushes (itemize "COMMANDS" STARTPOS) on texinfo-stack.
  969. ;; @enumerate pushes (enumerate 0 STARTPOS).
  970. ;; @item dispatches to the texinfo-item prop of the first elt of the list.
  971. ;; For itemize, this puts in and rescans the COMMANDS.
  972. ;; For enumerate, this increments the number and puts it in.
  973. ;; In either case, it puts a Backspace at the front of the line
  974. ;; which marks it not to be indented later.
  975. ;; All other lines get indented by 5 when the @end is reached.
  976.  
  977. (defvar texinfo-stack-depth 0
  978.   "Count of number of unpopped texinfo-push-stack calls.
  979. Used by @refill indenting command to avoid indenting within lists, etc.")
  980.  
  981. (defun texinfo-push-stack (check arg)
  982.   (setq texinfo-stack-depth (1+ texinfo-stack-depth))
  983.   (setq texinfo-stack
  984.     (cons (list check arg texinfo-command-start)
  985.           texinfo-stack)))
  986.  
  987. (defun texinfo-pop-stack (check)
  988.   (setq texinfo-stack-depth (1- texinfo-stack-depth))
  989.   (if (null texinfo-stack)
  990.       (error "Unmatched @end %s" check))
  991.   (if (not (eq (car (car texinfo-stack)) check))
  992.       (error "@end %s matches @%s"
  993.          check (car (car texinfo-stack))))
  994.   (prog1 (cdr (car texinfo-stack))
  995.      (setq texinfo-stack (cdr texinfo-stack))))
  996.  
  997. (put 'itemize 'texinfo-format 'texinfo-itemize)
  998. (defun texinfo-itemize ()
  999.   (texinfo-push-stack
  1000.    'itemize
  1001.    (progn (skip-chars-forward " \t")
  1002.           (if (eolp)
  1003.               "@bullet"
  1004.             (texinfo-parse-line-arg))))
  1005.   (texinfo-discard-line-with-args)
  1006.   (setq fill-column (- fill-column 5)))
  1007.  
  1008. (put 'itemize 'texinfo-end 'texinfo-end-itemize)
  1009. (defun texinfo-end-itemize ()
  1010.   (setq fill-column (+ fill-column 5))
  1011.   (texinfo-discard-command)
  1012.   (let ((stacktop
  1013.      (texinfo-pop-stack 'itemize)))
  1014.     (texinfo-do-itemize (nth 1 stacktop))))
  1015.  
  1016. (put 'enumerate 'texinfo-format 'texinfo-enumerate)
  1017. (defun texinfo-enumerate ()
  1018.   (texinfo-push-stack
  1019.    'enumerate 
  1020.    (progn (skip-chars-forward " \t")
  1021.           (if (eolp)
  1022.               1
  1023.             (read (current-buffer)))))
  1024.   (if (and (symbolp (car (cdr (car texinfo-stack))))
  1025.            (> 1 (length (symbol-name (car (cdr (car texinfo-stack)))))))
  1026.       (error
  1027.        "@enumerate: Use a number or letter, eg: 1, A, a, 3, B, or d." ))
  1028.   (texinfo-discard-line-with-args)
  1029.   (setq fill-column (- fill-column 5)))
  1030.  
  1031. (put 'enumerate 'texinfo-end 'texinfo-end-enumerate)
  1032. (defun texinfo-end-enumerate ()
  1033.   (setq fill-column (+ fill-column 5))
  1034.   (texinfo-discard-command)
  1035.   (let ((stacktop
  1036.      (texinfo-pop-stack 'enumerate)))
  1037.     (texinfo-do-itemize (nth 1 stacktop))))
  1038.  
  1039. ;; @alphaenumerate never became a standard part of Texinfo
  1040. (put 'alphaenumerate 'texinfo-format 'texinfo-alphaenumerate)
  1041. (defun texinfo-alphaenumerate ()
  1042.   (texinfo-push-stack 'alphaenumerate (1- ?a))
  1043.   (setq fill-column (- fill-column 5))
  1044.   (texinfo-discard-line))
  1045.  
  1046. (put 'alphaenumerate 'texinfo-end 'texinfo-end-alphaenumerate)
  1047. (defun texinfo-end-alphaenumerate ()
  1048.   (setq fill-column (+ fill-column 5))
  1049.   (texinfo-discard-command)
  1050.   (let ((stacktop
  1051.      (texinfo-pop-stack 'alphaenumerate)))
  1052.     (texinfo-do-itemize (nth 1 stacktop))))
  1053.  
  1054. ;; @capsenumerate never became a standard part of Texinfo
  1055. (put 'capsenumerate 'texinfo-format 'texinfo-capsenumerate)
  1056. (defun texinfo-capsenumerate ()
  1057.   (texinfo-push-stack 'capsenumerate (1- ?A))
  1058.   (setq fill-column (- fill-column 5))
  1059.   (texinfo-discard-line))
  1060.  
  1061. (put 'capsenumerate 'texinfo-end 'texinfo-end-capsenumerate)
  1062. (defun texinfo-end-capsenumerate ()
  1063.   (setq fill-column (+ fill-column 5))
  1064.   (texinfo-discard-command)
  1065.   (let ((stacktop
  1066.      (texinfo-pop-stack 'capsenumerate)))
  1067.     (texinfo-do-itemize (nth 1 stacktop))))
  1068.  
  1069. ;; At the @end, indent all the lines within the construct
  1070. ;; except those marked with backspace.  FROM says where
  1071. ;; construct started.
  1072. (defun texinfo-do-itemize (from)
  1073.   (save-excursion
  1074.    (while (progn (forward-line -1)
  1075.          (>= (point) from))
  1076.      (if (= (following-char) ?\b)
  1077.      (save-excursion
  1078.        (delete-char 1)
  1079.        (end-of-line)
  1080.        (delete-char 6))
  1081.        (if (not (looking-at "[ \t]*$"))
  1082.        (save-excursion (insert "     ")))))))
  1083.  
  1084. (put 'item 'texinfo-format 'texinfo-item)
  1085. (put 'itemx 'texinfo-format 'texinfo-item)
  1086. (defun texinfo-item ()
  1087.   (funcall (get (car (car texinfo-stack)) 'texinfo-item)))
  1088.  
  1089. (put 'itemize 'texinfo-item 'texinfo-itemize-item)
  1090. (defun texinfo-itemize-item ()
  1091.   ;; (texinfo-discard-line)   ; Did not handle text on same line as @item.
  1092.   (delete-region (1+ (point)) (save-excursion (beginning-of-line) (point)))
  1093.   (if (looking-at "[ \t]*[^ \t\n]+")
  1094.       ;; Text on same line as @item command.
  1095.       (insert "\b   " (nth 1 (car texinfo-stack)) " \n")
  1096.     ;; Else text on next line.
  1097.     (insert "\b   " (nth 1 (car texinfo-stack)) " "))
  1098.   (forward-line -1))
  1099.  
  1100. (put 'enumerate 'texinfo-item 'texinfo-enumerate-item)
  1101. (defun texinfo-enumerate-item ()
  1102.   (texinfo-discard-line)
  1103.   (let (enumerating-symbol)
  1104.     (cond ((integerp (car (cdr (car texinfo-stack))))
  1105.            (setq enumerating-symbol (car (cdr (car texinfo-stack))))
  1106.            (insert ?\b (format "%3d. " enumerating-symbol) ?\n)
  1107.            (setcar (cdr (car texinfo-stack)) (1+ enumerating-symbol)))
  1108.           ((symbolp (car (cdr (car texinfo-stack))))
  1109.            (setq enumerating-symbol
  1110.                  (symbol-name (car (cdr (car texinfo-stack)))))
  1111.            (if (or (equal ?\[ (string-to-char enumerating-symbol))
  1112.                    (equal ?\{ (string-to-char enumerating-symbol)))
  1113.                (error
  1114.                 "Too many items in enumerated list; alphabet ends at Z."))
  1115.            (insert ?\b (format "%3s. " enumerating-symbol) ?\n)
  1116.            (setcar (cdr (car texinfo-stack))
  1117.                    (make-symbol
  1118.                     (char-to-string
  1119.                      (1+ 
  1120.                       (string-to-char enumerating-symbol))))))
  1121.           (t
  1122.           (error
  1123.            "@enumerate: Use a number or letter, eg: 1, A, a, 3, B or d." )))
  1124.     (forward-line -1)))
  1125.  
  1126. (put 'alphaenumerate 'texinfo-item 'texinfo-alphaenumerate-item)
  1127. (defun texinfo-alphaenumerate-item ()
  1128.   (texinfo-discard-line)
  1129.   (let ((next (1+ (car (cdr (car texinfo-stack))))))
  1130.     (if (> next ?z)
  1131.     (error "More than 26 items in @alphaenumerate; get a bigger alphabet."))
  1132.     (setcar (cdr (car texinfo-stack)) next)
  1133.     (insert "\b  " next ". \n"))
  1134.   (forward-line -1))
  1135.  
  1136. (put 'capsenumerate 'texinfo-item 'texinfo-capsenumerate-item)
  1137. (defun texinfo-capsenumerate-item ()
  1138.   (texinfo-discard-line)
  1139.   (let ((next (1+ (car (cdr (car texinfo-stack))))))
  1140.     (if (> next ?Z)
  1141.     (error "More than 26 items in @capsenumerate; get a bigger alphabet."))
  1142.     (setcar (cdr (car texinfo-stack)) next)
  1143.     (insert "\b  " next ". \n"))
  1144.   (forward-line -1))
  1145.  
  1146.  
  1147. ;;; @table
  1148.  
  1149. ; The `@table' command produces two-column tables.
  1150.  
  1151. (put 'table 'texinfo-format 'texinfo-table)
  1152. (defun texinfo-table ()
  1153.   (texinfo-push-stack 
  1154.    'table 
  1155.    (progn (skip-chars-forward " \t")
  1156.           (if (eolp)
  1157.               "@asis"
  1158.             (texinfo-parse-line-arg))))
  1159.   (texinfo-discard-line-with-args)
  1160.   (setq fill-column (- fill-column 5)))
  1161.  
  1162. (put 'table 'texinfo-item 'texinfo-table-item)
  1163. (defun texinfo-table-item ()
  1164.   (let ((arg (texinfo-parse-arg-discard))
  1165.     (itemfont (car (cdr (car texinfo-stack)))))
  1166.     (insert ?\b itemfont ?\{ arg "}\n     \n"))
  1167.   (forward-line -2))
  1168.  
  1169. (put 'table 'texinfo-end 'texinfo-end-table)
  1170. (defun texinfo-end-table ()
  1171.   (setq fill-column (+ fill-column 5))
  1172.   (texinfo-discard-command)
  1173.   (let ((stacktop
  1174.      (texinfo-pop-stack 'table)))
  1175.     (texinfo-do-itemize (nth 1 stacktop))))
  1176.  
  1177. ;; @description appears to be an undocumented variant on @table that
  1178. ;; does not require an arg.  It fails in texinfo.tex 2.58 and is not
  1179. ;; part of makeinfo.c   The command appears to be a relic of the past.
  1180. (put 'description 'texinfo-end 'texinfo-end-table)
  1181. (put 'description 'texinfo-format 'texinfo-description)
  1182. (defun texinfo-description ()
  1183.   (texinfo-push-stack 'table "@asis")
  1184.   (setq fill-column (- fill-column 5))
  1185.   (texinfo-discard-line))
  1186.  
  1187.  
  1188. ;;; @ftable, @vtable
  1189.  
  1190. ; The `@ftable' and `@vtable' commands are like the `@table' command
  1191. ; but they also insert each entry in the first column of the table
  1192. ; into the function or variable index.
  1193.  
  1194. ;; Handle the @ftable and @vtable commands:
  1195.  
  1196. (put 'ftable 'texinfo-format 'texinfo-ftable)
  1197. (put 'vtable 'texinfo-format 'texinfo-vtable)
  1198.  
  1199. (defun texinfo-ftable () (texinfo-indextable 'ftable))
  1200. (defun texinfo-vtable () (texinfo-indextable 'vtable))
  1201.  
  1202. (defun texinfo-indextable (table-type)
  1203.   (texinfo-push-stack table-type (texinfo-parse-arg-discard))
  1204.   (setq fill-column (- fill-column 5)))
  1205.  
  1206. ;; Handle the @item commands within ftable and vtable:
  1207.  
  1208. (put 'ftable 'texinfo-item 'texinfo-ftable-item)
  1209. (put 'vtable 'texinfo-item 'texinfo-vtable-item)
  1210.  
  1211. (defun texinfo-ftable-item () (texinfo-indextable-item 'texinfo-findex))
  1212. (defun texinfo-vtable-item () (texinfo-indextable-item 'texinfo-vindex))
  1213.  
  1214. (defun texinfo-indextable-item (index-type)
  1215.   (let ((item (texinfo-parse-arg-discard))
  1216.         (itemfont (car (cdr (car texinfo-stack))))
  1217.         (indexvar index-type))
  1218.     (insert ?\b itemfont ?\{ item "}\n     \n")
  1219.     (set indexvar
  1220.          (cons
  1221.           (list item texinfo-last-node)
  1222.           (symbol-value indexvar)))
  1223.     (forward-line -2)))
  1224.  
  1225. ;; Handle @end ftable, @end vtable
  1226.  
  1227. (put 'ftable 'texinfo-end 'texinfo-end-ftable)
  1228. (put 'vtable 'texinfo-end 'texinfo-end-vtable)
  1229.  
  1230. (defun texinfo-end-ftable () (texinfo-end-indextable 'ftable))
  1231. (defun texinfo-end-vtable () (texinfo-end-indextable 'vtable))
  1232.  
  1233. (defun texinfo-end-indextable (table-type)
  1234.   (setq fill-column (+ fill-column 5))
  1235.   (texinfo-discard-command)
  1236.   (let ((stacktop
  1237.          (texinfo-pop-stack table-type)))
  1238.     (texinfo-do-itemize (nth 1 stacktop))))
  1239.  
  1240.  
  1241. ;;; @ifinfo,  @iftex, @tex
  1242.  
  1243. (put 'ifinfo 'texinfo-format 'texinfo-discard-line)
  1244. (put 'ifinfo 'texinfo-end 'texinfo-discard-command)
  1245.  
  1246. (put 'iftex 'texinfo-format 'texinfo-format-iftex)
  1247. (defun texinfo-format-iftex ()
  1248.   (delete-region texinfo-command-start
  1249.          (progn (re-search-forward "@end iftex[ \t]*\n")
  1250.             (point))))
  1251.  
  1252. (put 'tex 'texinfo-format 'texinfo-format-tex)
  1253. (defun texinfo-format-tex ()
  1254.   (delete-region texinfo-command-start
  1255.          (progn (re-search-forward "@end tex[ \t]*\n")
  1256.             (point))))
  1257.  
  1258.  
  1259. ;;; @titlepage
  1260.  
  1261. (put 'titlepage 'texinfo-format 'texinfo-format-titlepage)
  1262. (defun texinfo-format-titlepage ()
  1263.   (delete-region texinfo-command-start
  1264.          (progn (re-search-forward "@end titlepage[ \t]*\n")
  1265.             (point))))
  1266.  
  1267. (put 'endtitlepage 'texinfo-format 'texinfo-discard-line)
  1268.  
  1269. ; @titlespec         an alternative titling command; ignored by Info
  1270.  
  1271. (put 'titlespec 'texinfo-format 'texinfo-format-titlespec)
  1272. (defun texinfo-format-titlespec ()
  1273.   (delete-region texinfo-command-start
  1274.                  (progn (re-search-forward "@end titlespec[ \t]*\n")
  1275.                         (point))))
  1276.  
  1277. (put 'endtitlespec 'texinfo-format 'texinfo-discard-line)
  1278.  
  1279.  
  1280. ;;; @today
  1281.  
  1282. (put 'today 'texinfo-format 'texinfo-format-today)
  1283.  
  1284. ; Produces Day Month Year style of output.  eg `1 Jan 1900'
  1285. ; The `@today{}' command requires a pair of braces, like `@dots{}'.
  1286. (defun texinfo-format-today ()
  1287.   (texinfo-parse-arg-discard)
  1288.   (insert (format "%s %s %s"
  1289.           (substring (current-time-string) 8 10)
  1290.           (substring (current-time-string) 4 7)
  1291.           (substring (current-time-string) -4))))
  1292.  
  1293.  
  1294. ;;; @ignore
  1295.  
  1296. (put 'ignore 'texinfo-format 'texinfo-format-ignore)
  1297. (defun texinfo-format-ignore ()
  1298.   (delete-region texinfo-command-start
  1299.          (progn (re-search-forward "@end ignore[ \t]*\n")
  1300.             (point))))
  1301.  
  1302. (put 'endignore 'texinfo-format 'texinfo-discard-line)
  1303.  
  1304.  
  1305. ;;; Define the Info enclosure command: @definfoenclose
  1306.  
  1307. ; A `@definfoenclose' command may be used to define a highlighting
  1308. ; command for Info, but not for TeX.  A command defined using
  1309. ; `@definfoenclose' marks text by enclosing it in strings that precede
  1310. ; and follow the text.
  1311. ; 
  1312. ; Presumably, if you define a command with `@definfoenclose` for Info,
  1313. ; you will also define the same command in the TeX definitions file,
  1314. ; `texinfo.tex' in a manner appropriate for typesetting.
  1315. ; 
  1316. ; Write a `@definfoenclose' command on a line and follow it with three
  1317. ; arguments separated by commas (commas are used as separators in an
  1318. ; `@node' line in the same way).  The first argument to
  1319. ; `@definfoenclose' is the @-command name \(without the `@'\); the
  1320. ; second argument is the Info start delimiter string; and the third
  1321. ; argument is the Info end delimiter string.  The latter two arguments
  1322. ; enclose the highlighted text in the Info file.  A delimiter string
  1323. ; may contain spaces.  Neither the start nor end delimiter is
  1324. ; required.  However, if you do not provide a start delimiter, you
  1325. ; must follow the command name with two commas in a row; otherwise,
  1326. ; the Info formatting commands will misinterpret the end delimiter
  1327. ; string as a start delimiter string.
  1328. ; 
  1329. ; An enclosure command defined this way takes one argument in braces.
  1330. ;
  1331. ; For example, you can write:
  1332. ;
  1333. ;     @ifinfo
  1334. ;     @definfoenclose phoo, //, \\
  1335. ;     @end ifinfo
  1336. ;
  1337. ; near the beginning of a Texinfo file at the beginning of the lines
  1338. ; to define `@phoo' as an Info formatting command that inserts `//'
  1339. ; before and `\\' after the argument to `@phoo'.  You can then write
  1340. ; `@phoo{bar}' wherever you want `//bar\\' highlighted in Info.
  1341. ;
  1342. ; Also, for TeX formatting, you could write 
  1343. ;
  1344. ;     @iftex
  1345. ;     @global@let@phoo=@i
  1346. ;     @end iftex
  1347. ;
  1348. ; to define `@phoo' as a command that causes TeX to typeset
  1349. ; the argument to `@phoo' in italics.
  1350. ;
  1351. ; Note that each definition applies to its own formatter: one for TeX,
  1352. ; the other for texinfo-format-buffer or texinfo-format-region.
  1353. ;
  1354. ; Here is another example: write
  1355. ;
  1356. ;     @definfoenclose headword, , :
  1357. ;
  1358. ; near the beginning of the file, to define `@headword' as an Info
  1359. ; formatting command that inserts nothing before and a colon after the
  1360. ; argument to `@headword'.
  1361.  
  1362. (put 'definfoenclose 'texinfo-format 'texinfo-define-info-enclosure)
  1363. (defun texinfo-define-info-enclosure ()
  1364.   (let* ((args (texinfo-format-parse-line-args))
  1365.      (command-name (nth 0 args))
  1366.      (beginning-delimiter (or (nth 1 args) ""))
  1367.      (end-delimiter (or (nth 2 args) "")))
  1368.     (texinfo-discard-command)
  1369.     (setq texinfo-enclosure-list
  1370.     (cons
  1371.      (list command-name
  1372.            (list
  1373.         beginning-delimiter
  1374.         end-delimiter))
  1375.      texinfo-enclosure-list))))
  1376.  
  1377.  
  1378. ;;; @var, @code and the like
  1379.  
  1380. (put 'var 'texinfo-format 'texinfo-format-var)
  1381. ;  @sc  a small caps font for TeX; formatted as `var' in Info
  1382. (put 'sc 'texinfo-format 'texinfo-format-var)
  1383. (defun texinfo-format-var ()
  1384.   (insert (upcase (texinfo-parse-arg-discard)))
  1385.   (goto-char texinfo-command-start))
  1386.  
  1387. ; various noops
  1388.  
  1389. (put 'b 'texinfo-format 'texinfo-format-noop)
  1390. (put 'i 'texinfo-format 'texinfo-format-noop)
  1391. (put 'r 'texinfo-format 'texinfo-format-noop)
  1392. (put 't 'texinfo-format 'texinfo-format-noop)
  1393. (put 'w 'texinfo-format 'texinfo-format-noop)
  1394. (put 'asis 'texinfo-format 'texinfo-format-noop)
  1395. (put 'dmn 'texinfo-format 'texinfo-format-noop)
  1396. (put 'key 'texinfo-format 'texinfo-format-noop)
  1397. (put 'math 'texinfo-format 'texinfo-format-noop)
  1398. (put 'titlefont 'texinfo-format 'texinfo-format-noop)
  1399. (defun texinfo-format-noop ()
  1400.   (insert (texinfo-parse-arg-discard))
  1401.   (goto-char texinfo-command-start))
  1402.  
  1403. (put 'cite 'texinfo-format 'texinfo-format-code)
  1404. (put 'code 'texinfo-format 'texinfo-format-code)
  1405. (put 'file 'texinfo-format 'texinfo-format-code)
  1406. (put 'kbd 'texinfo-format 'texinfo-format-code)
  1407. (put 'samp 'texinfo-format 'texinfo-format-code)
  1408. (defun texinfo-format-code ()
  1409.   (insert "`" (texinfo-parse-arg-discard) "'")
  1410.   (goto-char texinfo-command-start))
  1411.  
  1412. (put 'emph 'texinfo-format 'texinfo-format-emph)
  1413. (put 'strong 'texinfo-format 'texinfo-format-emph)
  1414. (defun texinfo-format-emph ()
  1415.   (insert "*" (texinfo-parse-arg-discard) "*")
  1416.   (goto-char texinfo-command-start))
  1417.  
  1418. (put 'dfn 'texinfo-format 'texinfo-format-defn)
  1419. (put 'defn 'texinfo-format 'texinfo-format-defn)
  1420. (defun texinfo-format-defn ()
  1421.   (insert "\"" (texinfo-parse-arg-discard) "\"")
  1422.   (goto-char texinfo-command-start))
  1423.  
  1424. (put 'bullet 'texinfo-format 'texinfo-format-bullet)
  1425. (defun texinfo-format-bullet ()
  1426.   "Insert an asterisk.
  1427. If used within a line, follow `@bullet' with braces."
  1428.   (texinfo-optional-braces-discard)
  1429.   (insert "*"))
  1430.  
  1431.  
  1432. ;;; @example, @lisp, @quotation, @display, @smalllisp, @smallexample
  1433.  
  1434. (put 'display 'texinfo-format 'texinfo-format-example)
  1435. (put 'example 'texinfo-format 'texinfo-format-example)
  1436. (put 'lisp 'texinfo-format 'texinfo-format-example)
  1437. (put 'quotation 'texinfo-format 'texinfo-format-example)
  1438. (put 'smallexample 'texinfo-format 'texinfo-format-example)
  1439. (put 'smalllisp 'texinfo-format 'texinfo-format-example)
  1440. (defun texinfo-format-example ()
  1441.   (texinfo-push-stack 'example nil)
  1442.   (setq fill-column (- fill-column 5))
  1443.   (texinfo-discard-line))
  1444.  
  1445. (put 'example 'texinfo-end 'texinfo-end-example)
  1446. (put 'display 'texinfo-end 'texinfo-end-example)
  1447. (put 'lisp 'texinfo-end 'texinfo-end-example)
  1448. (put 'quotation 'texinfo-end 'texinfo-end-example)
  1449. (put 'smallexample 'texinfo-end 'texinfo-end-example)
  1450. (put 'smalllisp 'texinfo-end 'texinfo-end-example)
  1451. (defun texinfo-end-example ()
  1452.   (setq fill-column (+ fill-column 5))
  1453.   (texinfo-discard-command)
  1454.   (let ((stacktop
  1455.      (texinfo-pop-stack 'example)))
  1456.     (texinfo-do-itemize (nth 1 stacktop))))
  1457.  
  1458. (put 'exdent 'texinfo-format 'texinfo-format-exdent)
  1459. (defun texinfo-format-exdent ()
  1460.   (texinfo-discard-command)
  1461.   (delete-region (point)
  1462.          (progn
  1463.           (skip-chars-forward " ")
  1464.           (point)))
  1465.   (insert ?\b)
  1466.   ;; Cancel out the deletion that texinfo-do-itemize
  1467.   ;; is going to do at the end of this line.
  1468.   (save-excursion
  1469.     (end-of-line)
  1470.     (insert "\n     ")))
  1471.  
  1472.  
  1473. ;;; @cartouche 
  1474.  
  1475. ; The @cartouche command is a noop in Info; in a printed manual,
  1476. ; it makes a box with rounded corners.
  1477.  
  1478. (put 'cartouche 'texinfo-format 'texinfo-discard-line)
  1479. (put 'cartouche 'texinfo-end 'texinfo-discard-command)
  1480.  
  1481.  
  1482. ;;; @flushleft and @format
  1483.  
  1484. ; The @flushleft command left justifies every line but leaves the
  1485. ; right end ragged.  As far as Info is concerned, @flushleft is a
  1486. ; `do-nothing' command
  1487.  
  1488. ; The @format command is similar to @example except that it does not
  1489. ; indent; this means that in Info, @format is similar to @flushleft.
  1490.  
  1491. (put 'format 'texinfo-format 'texinfo-format-flushleft)
  1492. (put 'flushleft 'texinfo-format 'texinfo-format-flushleft)
  1493. (defun texinfo-format-flushleft ()
  1494.   (texinfo-discard-line))
  1495.  
  1496. (put 'format 'texinfo-end 'texinfo-end-flushleft)
  1497. (put 'flushleft 'texinfo-end 'texinfo-end-flushleft)
  1498. (defun texinfo-end-flushleft ()
  1499.   (texinfo-discard-command))
  1500.  
  1501.  
  1502. ;;; @flushright
  1503.  
  1504. ; The @flushright command right justifies every line but leaves the
  1505. ; left end ragged.  Spaces and tabs at the right ends of lines are
  1506. ; removed so that visible text lines up on the right side.
  1507.  
  1508. (put 'flushright 'texinfo-format 'texinfo-format-flushright)
  1509. (defun texinfo-format-flushright ()
  1510.   (texinfo-push-stack 'flushright nil)
  1511.   (texinfo-discard-line))
  1512.  
  1513. (put 'flushright 'texinfo-end 'texinfo-end-flushright)
  1514. (defun texinfo-end-flushright ()
  1515.   (texinfo-discard-command)
  1516.  
  1517.   (let ((stacktop
  1518.          (texinfo-pop-stack 'flushright)))
  1519.  
  1520.     (texinfo-do-flushright (nth 1 stacktop))))
  1521.  
  1522. (defun texinfo-do-flushright (from)
  1523.   (save-excursion
  1524.    (while (progn (forward-line -1)
  1525.                  (>= (point) from))
  1526.  
  1527.      (beginning-of-line)
  1528.      (insert
  1529.       (make-string
  1530.        (- fill-column
  1531.           (save-excursion
  1532.             (end-of-line) 
  1533.             (skip-chars-backward " \t")
  1534.             (delete-region (point) (progn (end-of-line) (point)))
  1535.             (current-column)))  
  1536.        ? )))))
  1537.  
  1538.  
  1539. ;;; @ctrl, @TeX, @copyright, @minus, @dots
  1540.  
  1541. (put 'ctrl 'texinfo-format 'texinfo-format-ctrl)
  1542. (defun texinfo-format-ctrl ()
  1543.   (let ((str (texinfo-parse-arg-discard)))
  1544.     (insert (logand 31 (aref str 0)))))
  1545.  
  1546. (put 'TeX 'texinfo-format 'texinfo-format-TeX)
  1547. (defun texinfo-format-TeX ()
  1548.   (texinfo-parse-arg-discard)
  1549.   (insert "TeX"))
  1550.  
  1551. (put 'copyright 'texinfo-format 'texinfo-format-copyright)
  1552. (defun texinfo-format-copyright ()
  1553.   (texinfo-parse-arg-discard)
  1554.   (insert "(C)"))
  1555.  
  1556. (put 'minus 'texinfo-format 'texinfo-format-minus)
  1557. (defun texinfo-format-minus ()
  1558.   "Insert a minus sign.
  1559. If used within a line, follow `@minus' with braces."
  1560.   (texinfo-optional-braces-discard)
  1561.   (insert "-"))
  1562.  
  1563. (put 'dots 'texinfo-format 'texinfo-format-dots)
  1564. (defun texinfo-format-dots ()
  1565.   (texinfo-parse-arg-discard)
  1566.   (insert "..."))
  1567.  
  1568.  
  1569. ;;; Refilling and indenting:  @refill, @paragraphindent, @noindent
  1570.  
  1571. ;;; Indent only those paragraphs that are refilled as a result of an
  1572. ;;; @refill command.  
  1573.  
  1574. ;    * If the value is `asis', do not change the existing indentation at
  1575. ;      the starts of paragraphs.
  1576.  
  1577. ;    * If the value zero, delete any existing indentation.
  1578.  
  1579. ;    * If the value is greater than zero, indent each paragraph by that
  1580. ;      number of spaces.
  1581.  
  1582. ;;; But do not refill paragraphs with an @refill command that are
  1583. ;;; preceded by @noindent or are part of a table, list, or deffn.
  1584.  
  1585. (defvar texinfo-paragraph-indent "asis"
  1586.   "Number of spaces for @refill to indent a paragraph; else to leave as is.")
  1587.  
  1588. (put 'paragraphindent 'texinfo-format 'texinfo-paragraphindent)
  1589.  
  1590. (defun texinfo-paragraphindent ()
  1591.   "Specify the number of spaces for @refill to indent a paragraph.
  1592. Default is to leave the number of spaces as is."
  1593.   (let ((arg  (texinfo-parse-arg-discard)))
  1594.     (if (string= "asis" arg)
  1595.         (setq texinfo-paragraph-indent "asis")
  1596.       (setq texinfo-paragraph-indent (string-to-int arg)))))
  1597.  
  1598. (put 'refill 'texinfo-format 'texinfo-format-refill)
  1599. (defun texinfo-format-refill ()
  1600.   "Refill paragraph. Also, indent first line as set by @paragraphindent.
  1601. Default is to leave paragraph indentation as is."
  1602.   (texinfo-discard-command)
  1603.   (forward-paragraph -1)     
  1604.   (if (looking-at "[ \t\n]*$") (forward-line 1))
  1605.   ;; Do not indent if an entry in a list, table, or deffn,
  1606.   ;; or if paragraph is preceded by @noindent.
  1607.   ;; Otherwise, indent
  1608.   (cond 
  1609.    ;; delete a @noindent line and do not indent paragraph
  1610.    ((save-excursion (forward-line -1)
  1611.                     (looking-at "^@noindent")) 
  1612.     (forward-line -1)
  1613.     (delete-region (point) (progn (forward-line 1) (point))))
  1614.    ;; do nothing if "asis"
  1615.    ((equal texinfo-paragraph-indent "asis"))
  1616.    ;; do no indenting in list, etc.
  1617.    ((> texinfo-stack-depth 0))   
  1618.    ;; otherwise delete existing whitespace and indent
  1619.    (t 
  1620.     (delete-region (point) (progn (skip-chars-forward " \t") (point)))
  1621.     (insert (make-string texinfo-paragraph-indent ? ))))
  1622.   (forward-paragraph 1) 
  1623.   (forward-line -1)
  1624.   (end-of-line)
  1625.   (fill-paragraph nil))
  1626.  
  1627. (put 'noindent 'texinfo-format 'texinfo-noindent)
  1628. (defun texinfo-noindent ()  
  1629.   (save-excursion 
  1630.     (forward-paragraph 1)
  1631.     (if (search-backward "@refill"
  1632.                             (save-excursion (forward-line -1) (point)) t)
  1633.         () ; leave @noindent command so @refill command knows not to indent
  1634.       ;; else
  1635.       (texinfo-discard-line))))
  1636.  
  1637.  
  1638. ;;; Index generation
  1639.  
  1640. (put 'vindex 'texinfo-format 'texinfo-format-vindex)
  1641. (defun texinfo-format-vindex ()
  1642.   (texinfo-index 'texinfo-vindex))
  1643.  
  1644. (put 'cindex 'texinfo-format 'texinfo-format-cindex)
  1645. (defun texinfo-format-cindex ()
  1646.   (texinfo-index 'texinfo-cindex))
  1647.  
  1648. (put 'findex 'texinfo-format 'texinfo-format-findex)
  1649. (defun texinfo-format-findex ()
  1650.   (texinfo-index 'texinfo-findex))
  1651.  
  1652. (put 'pindex 'texinfo-format 'texinfo-format-pindex)
  1653. (defun texinfo-format-pindex ()
  1654.   (texinfo-index 'texinfo-pindex))
  1655.  
  1656. (put 'tindex 'texinfo-format 'texinfo-format-tindex)
  1657. (defun texinfo-format-tindex ()
  1658.   (texinfo-index 'texinfo-tindex))
  1659.  
  1660. (put 'kindex 'texinfo-format 'texinfo-format-kindex)
  1661. (defun texinfo-format-kindex ()
  1662.   (texinfo-index 'texinfo-kindex))
  1663.  
  1664. (defun texinfo-index (indexvar)
  1665.   (let ((arg (texinfo-parse-expanded-arg)))
  1666.     (texinfo-discard-command)
  1667.     (set indexvar
  1668.      (cons (list arg
  1669.                      texinfo-last-node
  1670.                      ;; Region formatting may not provide last node position.
  1671.              (if texinfo-last-node-pos
  1672.                          (1+ (count-lines texinfo-last-node-pos (point)))
  1673.                        1))
  1674.            (symbol-value indexvar)))))
  1675.  
  1676. (defconst texinfo-indexvar-alist
  1677.   '(("cp" . texinfo-cindex)
  1678.     ("fn" . texinfo-findex)
  1679.     ("vr" . texinfo-vindex)
  1680.     ("tp" . texinfo-tindex)
  1681.     ("pg" . texinfo-pindex)
  1682.     ("ky" . texinfo-kindex)))
  1683.  
  1684.  
  1685. ;;; @defindex   @defcodeindex
  1686. (put 'defindex 'texinfo-format 'texinfo-format-defindex)
  1687. (put 'defcodeindex 'texinfo-format 'texinfo-format-defindex)
  1688.  
  1689. (defun texinfo-format-defindex ()
  1690.   (let* ((index-name (texinfo-parse-arg-discard)) ; eg: `aa'
  1691.          (indexing-command (intern (concat index-name "index")))
  1692.          (index-formatting-command      ; eg: `texinfo-format-aaindex'
  1693.           (intern (concat "texinfo-format-" index-name "index")))
  1694.          (index-alist-name              ; eg: `texinfo-aaindex'
  1695.           (intern (concat "texinfo-" index-name "index"))))
  1696.  
  1697.     (set index-alist-name nil)
  1698.  
  1699.     (put indexing-command               ; eg, aaindex
  1700.          'texinfo-format
  1701.          index-formatting-command)      ; eg, texinfo-format-aaindex
  1702.  
  1703.     ;; eg: "aa" . texinfo-aaindex
  1704.     (or (assoc index-name texinfo-indexvar-alist)
  1705.         (setq texinfo-indexvar-alist
  1706.               (cons
  1707.                (cons index-name
  1708.                      index-alist-name)
  1709.                texinfo-indexvar-alist)))
  1710.  
  1711.     (fset index-formatting-command
  1712.           (list 'lambda 'nil
  1713.                 (list 'texinfo-index 
  1714.                       (list 'quote index-alist-name))))))
  1715.  
  1716.  
  1717. ;;; @synindex   @syncodeindex
  1718.  
  1719. (put 'synindex 'texinfo-format 'texinfo-format-synindex)
  1720. (put 'syncodeindex 'texinfo-format 'texinfo-format-synindex)
  1721.  
  1722. (defun texinfo-format-synindex ()
  1723.   (let* ((args (texinfo-parse-arg-discard))
  1724.          (second (cdr (read-from-string args)))
  1725.          (joiner (symbol-name (car (read-from-string args))))
  1726.          (joined (symbol-name (car (read-from-string args second)))))
  1727.  
  1728.     (if (assoc joiner texinfo-short-index-cmds-alist)
  1729.         (put
  1730.           (cdr (assoc joiner texinfo-short-index-cmds-alist))
  1731.          'texinfo-format
  1732.          (or (cdr (assoc joined texinfo-short-index-format-cmds-alist))
  1733.              (intern (concat "texinfo-format-" joined "index"))))
  1734.       (put
  1735.        (intern (concat joiner "index"))
  1736.        'texinfo-format
  1737.        (or (cdr(assoc joined texinfo-short-index-format-cmds-alist))
  1738.            (intern (concat "texinfo-format-" joined "index")))))))
  1739.  
  1740. (defconst texinfo-short-index-cmds-alist
  1741.   '(("cp" . cindex)
  1742.     ("fn" . findex)
  1743.     ("vr" . vindex)
  1744.     ("tp" . tindex)
  1745.     ("pg" . pindex)
  1746.     ("ky" . kindex)))
  1747.  
  1748. (defconst texinfo-short-index-format-cmds-alist
  1749.   '(("cp" . texinfo-format-cindex)
  1750.     ("fn" . texinfo-format-findex)
  1751.     ("vr" . texinfo-format-vindex)
  1752.     ("tp" . texinfo-format-tindex)
  1753.     ("pg" . texinfo-format-pindex)
  1754.     ("ky" . texinfo-format-kindex)))
  1755.  
  1756.  
  1757. ;;; Sort and index (for VMS)
  1758.  
  1759. ;; Sort an index which is in the current buffer between START and END.
  1760. ;; Used on VMS, where the `sort' utility is not available.
  1761. (defun texinfo-sort-region (start end)
  1762.   (require 'sort)
  1763.   (save-restriction
  1764.     (narrow-to-region start end)
  1765.     (sort-subr nil 'forward-line 'end-of-line 'texinfo-sort-startkeyfun)))
  1766.  
  1767. ;; Subroutine for sorting an index.
  1768. ;; At start of a line, return a string to sort the line under.
  1769. (defun texinfo-sort-startkeyfun ()
  1770.   (let ((line
  1771.      (buffer-substring (point) (save-excursion (end-of-line) (point)))))
  1772.     ;; Canonicalize whitespace and eliminate funny chars.
  1773.     (while (string-match "[ \t][ \t]+\\|[^a-z0-9 ]+" line)
  1774.       (setq line (concat (substring line 0 (match-beginning 0))
  1775.              " "
  1776.              (substring line (match-end 0) (length line)))))
  1777.     line))
  1778.  
  1779.  
  1780. ;;; @printindex
  1781.  
  1782. (put 'printindex 'texinfo-format 'texinfo-format-printindex)
  1783.  
  1784. (defun texinfo-format-printindex ()
  1785.   (let ((indexelts (symbol-value
  1786.             (cdr (assoc (texinfo-parse-arg-discard)
  1787.                 texinfo-indexvar-alist))))
  1788.     opoint)
  1789.     (insert "\n* Menu:\n\n")
  1790.     (setq opoint (point))
  1791.     (texinfo-print-index nil indexelts)
  1792.  
  1793.     (if (eq system-type 'vax-vms)
  1794.         (texinfo-sort-region opoint (point))
  1795.       (shell-command-on-region opoint (point) "sort -fd" 1))))
  1796.  
  1797. (defun texinfo-print-index (file indexelts)
  1798.   (while indexelts
  1799.     (if (stringp (car (car indexelts)))
  1800.         (progn
  1801.           (insert "* " (car (car indexelts)) ": " )
  1802.           (indent-to 32)
  1803.           (insert
  1804.            (if file (concat "(" file ")") "")
  1805.            (nth 1 (car indexelts)) ".")
  1806.           (indent-to 54)
  1807.           (insert
  1808.            (if (nth 2 (car indexelts))
  1809.                (format "  %d." (nth 2 (car indexelts)))
  1810.              "")
  1811.            "\n"))
  1812.       ;; index entries from @include'd file
  1813.       (texinfo-print-index (nth 1 (car indexelts))
  1814.                (nth 2 (car indexelts))))
  1815.     (setq indexelts (cdr indexelts))))
  1816.  
  1817.  
  1818. ;;; Glyphs: @equiv, @error, etc
  1819.  
  1820. ;; @equiv           to show that two expressions are equivalent
  1821. ;; @error           to show an error message
  1822. ;; @expansion       to show what a macro expands to
  1823. ;; @point           to show the location of point in an example
  1824. ;; @print           to show what an evaluated expression prints
  1825. ;; @result          to indicate the value returned by an expression
  1826.  
  1827. (put 'equiv 'texinfo-format 'texinfo-format-equiv)
  1828. (defun texinfo-format-equiv ()
  1829.   (texinfo-parse-arg-discard)
  1830.   (insert "=="))
  1831.  
  1832. (put 'error 'texinfo-format 'texinfo-format-error)
  1833. (defun texinfo-format-error ()
  1834.   (texinfo-parse-arg-discard)
  1835.   (insert "error-->"))
  1836.  
  1837. (put 'expansion 'texinfo-format 'texinfo-format-expansion)
  1838. (defun texinfo-format-expansion ()
  1839.   (texinfo-parse-arg-discard)
  1840.   (insert "==>"))
  1841.  
  1842. (put 'point 'texinfo-format 'texinfo-format-point)
  1843. (defun texinfo-format-point ()
  1844.   (texinfo-parse-arg-discard)
  1845.   (insert "-!-"))
  1846.  
  1847. (put 'print 'texinfo-format 'texinfo-format-print)
  1848. (defun texinfo-format-print ()
  1849.   (texinfo-parse-arg-discard)
  1850.   (insert "-|"))
  1851.  
  1852. (put 'result 'texinfo-format 'texinfo-format-result)
  1853. (defun texinfo-format-result ()
  1854.   (texinfo-parse-arg-discard)
  1855.   (insert "=>"))
  1856.  
  1857.  
  1858. ;;; Definition formatting: @deffn, @defun, etc
  1859.  
  1860. ;; What definition formatting produces:
  1861. ;;
  1862. ;; @deffn category name args...
  1863. ;;     In Info, `Category: name ARGS'
  1864. ;;     In index: name:  node. line#.
  1865. ;;
  1866. ;; @defvr category name 
  1867. ;;     In Info, `Category: name'
  1868. ;;     In index: name:  node. line#.
  1869. ;;
  1870. ;; @deftp category name attributes...
  1871. ;; `category name attributes...'       Note: @deftp args in lower case.
  1872. ;;     In index: name:  node. line#.
  1873. ;;
  1874. ;; Specialized function-like or variable-like entity:
  1875. ;;
  1876. ;; @defun, @defmac, @defspec, @defvar, @defopt
  1877. ;;
  1878. ;; @defun name args           In Info, `Function: name ARGS'
  1879. ;; @defmac name args          In Info, `Macro: name ARGS'
  1880. ;; @defvar name               In Info, `Variable: name'
  1881. ;; etc.
  1882. ;;     In index: name:  node. line#.
  1883. ;;
  1884. ;; Generalized typed-function-like or typed-variable-like entity:
  1885. ;; @deftypefn category data-type name args...
  1886. ;;     In Info, `Category:  data-type name args...'
  1887. ;; @deftypevr category data-type name 
  1888. ;;     In Info, `Category:  data-type name'
  1889. ;;     In index: name:  node. line#.
  1890. ;;
  1891. ;; Specialized typed-function-like or typed-variable-like entity:
  1892. ;; @deftypefun data-type name args...
  1893. ;;     In Info, `Function:  data-type name ARGS'
  1894. ;;     In index: name:  node. line#.   
  1895. ;;
  1896. ;; @deftypevar data-type name 
  1897. ;;     In Info, `Variable:  data-type name'
  1898. ;;     In index: name:  node. line#.   but include args after name!?
  1899. ;;
  1900. ;; Generalized object oriented entity: 
  1901. ;; @defop category class name args...
  1902. ;;     In Info, `Category on class: name ARG'
  1903. ;;     In index: name on class: node. line#.
  1904. ;;
  1905. ;; @defcv category class name         
  1906. ;;     In Info, `Category of class: name'
  1907. ;;     In index: name of class: node. line#.
  1908. ;;
  1909. ;; Specialized object oriented entity:
  1910. ;; @defmethod class name args... 
  1911. ;;     In Info, `Method on class: name ARGS'
  1912. ;;     In index: name on class: node. line#.
  1913. ;;
  1914. ;; @defivar class name
  1915. ;;     In Info, `Instance variable of class: name'
  1916. ;;     In index: name of class: node. line#.
  1917.  
  1918.  
  1919. ;;; The definition formatting functions
  1920.  
  1921. (defun texinfo-format-defun ()
  1922.   (texinfo-push-stack 'defun nil)
  1923.   (setq fill-column (- fill-column 5))
  1924.   (texinfo-format-defun-1 t))
  1925.  
  1926. (defun texinfo-end-defun ()
  1927.   (setq fill-column (+ fill-column 5))
  1928.   (texinfo-discard-command)
  1929.   (let ((start (nth 1 (texinfo-pop-stack 'defun))))
  1930.     (texinfo-do-itemize start)
  1931.     ;; Delete extra newline inserted after header.
  1932.     (save-excursion
  1933.       (goto-char start)
  1934.       (delete-char -1))))
  1935.  
  1936. (defun texinfo-format-defunx ()
  1937.   (texinfo-format-defun-1 nil))
  1938.  
  1939. (defun texinfo-format-defun-1 (first-p)
  1940.   (let ((parse-args (texinfo-format-parse-defun-args))
  1941.     (command-type (get texinfo-command-name 'texinfo-defun-type)))
  1942.     (texinfo-discard-command)
  1943.     ;; Delete extra newline inserted after previous header line.
  1944.     (if (not first-p)
  1945.     (delete-char -1))
  1946.     (funcall
  1947.      (get texinfo-command-name 'texinfo-deffn-formatting-property) parse-args)
  1948.     ;; Insert extra newline so that paragraph filling does not mess
  1949.     ;; with header line.
  1950.     (insert "\n\n")
  1951.     (rplaca (cdr (cdr (car texinfo-stack))) (point))
  1952.     (funcall
  1953.      (get texinfo-command-name 'texinfo-defun-indexing-property) parse-args)))
  1954.  
  1955. ;;; Formatting the first line of a definition
  1956.  
  1957. ;; @deffn, @defvr, @deftp
  1958. (put 'deffn 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  1959. (put 'deffnx 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  1960. (put 'defvr 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  1961. (put 'defvrx 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  1962. (put 'deftp 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  1963. (put 'deftpx 'texinfo-deffn-formatting-property 'texinfo-format-deffn)
  1964. (defun texinfo-format-deffn (parsed-args)
  1965.   ;; Generalized function-like, variable-like, or generic data-type entity:
  1966.   ;; @deffn category name args...
  1967.   ;;     In Info, `Category: name ARGS'
  1968.   ;; @deftp category name attributes...
  1969.   ;; `category name attributes...'       Note: @deftp args in lower case.
  1970.   (let ((category (car parsed-args))
  1971.         (name (car (cdr parsed-args)))
  1972.         (args (cdr (cdr parsed-args))))
  1973.     (insert " -- " category ": " name)
  1974.     (while args
  1975.       (insert " "
  1976.               (if (or (= ?& (aref (car args) 0))
  1977.                       (eq (eval (car command-type)) 'deftp-type))
  1978.                   (car args)
  1979.                 (upcase (car args))))
  1980.       (setq args (cdr args)))))
  1981.  
  1982. ;; @defun, @defmac, @defspec, @defvar, @defopt: Specialized, simple
  1983. (put 'defun 'texinfo-deffn-formatting-property
  1984.      'texinfo-format-specialized-defun)
  1985. (put 'defunx 'texinfo-deffn-formatting-property
  1986.      'texinfo-format-specialized-defun)
  1987. (put 'defmac 'texinfo-deffn-formatting-property
  1988.      'texinfo-format-specialized-defun)
  1989. (put 'defmacx 'texinfo-deffn-formatting-property
  1990.      'texinfo-format-specialized-defun)
  1991. (put 'defspec 'texinfo-deffn-formatting-property
  1992.      'texinfo-format-specialized-defun)
  1993. (put 'defspecx 'texinfo-deffn-formatting-property
  1994.      'texinfo-format-specialized-defun)
  1995. (put 'defvar 'texinfo-deffn-formatting-property
  1996.      'texinfo-format-specialized-defun)
  1997. (put 'defvarx 'texinfo-deffn-formatting-property
  1998.      'texinfo-format-specialized-defun)
  1999. (put 'defopt 'texinfo-deffn-formatting-property
  2000.      'texinfo-format-specialized-defun)
  2001. (put 'defoptx 'texinfo-deffn-formatting-property
  2002.      'texinfo-format-specialized-defun)
  2003. (defun texinfo-format-specialized-defun (parsed-args)
  2004.   ;; Specialized function-like or variable-like entity:
  2005.   ;; @defun name args           In Info, `Function: Name ARGS'
  2006.   ;; @defmac name args          In Info, `Macro: Name ARGS'
  2007.   ;; @defvar name               In Info, `Variable: Name'
  2008.   ;; Use cdr of command-type to determine category:
  2009.   (let ((category (car (cdr command-type)))
  2010.         (name (car parsed-args))
  2011.         (args (cdr parsed-args)))
  2012.     (insert " -- " category ": " name)
  2013.     (while args
  2014.       (insert " "
  2015.               (if (= ?& (aref (car args) 0))
  2016.                   (car args)
  2017.                 (upcase (car args))))
  2018.       (setq args (cdr args)))))
  2019.  
  2020. ;; @deftypefn, @deftypevr: Generalized typed
  2021. (put 'deftypefn 'texinfo-deffn-formatting-property 'texinfo-format-deftypefn)
  2022. (put 'deftypefnx 'texinfo-deffn-formatting-property 'texinfo-format-deftypefn)
  2023. (put 'deftypevr 'texinfo-deffn-formatting-property 'texinfo-format-deftypefn)
  2024. (put 'deftypevrx 'texinfo-deffn-formatting-property 'texinfo-format-deftypefn)
  2025. (defun texinfo-format-deftypefn (parsed-args)
  2026.   ;; Generalized typed-function-like or typed-variable-like entity:
  2027.   ;; @deftypefn category data-type name args...
  2028.   ;;     In Info, `Category:  data-type name args...'
  2029.   ;; @deftypevr category data-type name 
  2030.   ;;     In Info, `Category:  data-type name'
  2031.   ;; Note: args in lower case, unless modified in command line.
  2032.   (let ((category (car parsed-args))
  2033.         (data-type (car (cdr parsed-args)))
  2034.         (name (car (cdr (cdr parsed-args))))
  2035.         (args (cdr (cdr (cdr parsed-args)))))
  2036.     (insert " -- " category ": " data-type " " name)
  2037.     (while args
  2038.       (insert " " (car args))
  2039.       (setq args (cdr args)))))
  2040.  
  2041. ;; @deftypefun, @deftypevar: Specialized typed
  2042. (put 'deftypefun 'texinfo-deffn-formatting-property 'texinfo-format-deftypefun)
  2043. (put 'deftypefunx 'texinfo-deffn-formatting-property
  2044.      'texinfo-format-deftypefun)
  2045. (put 'deftypevar 'texinfo-deffn-formatting-property 'texinfo-format-deftypefun)
  2046. (put 'deftypevarx 'texinfo-deffn-formatting-property
  2047.      'texinfo-format-deftypefun)
  2048. (defun texinfo-format-deftypefun (parsed-args)
  2049.   ;; Specialized typed-function-like or typed-variable-like entity:
  2050.   ;; @deftypefun data-type name args...
  2051.   ;;     In Info, `Function:  data-type name ARGS'
  2052.   ;; @deftypevar data-type name 
  2053.   ;;     In Info, `Variable:  data-type name'
  2054.   ;; Note: args in lower case, unless modified in command line.
  2055.   ;; Use cdr of command-type to determine category:
  2056.   (let ((category (car (cdr command-type)))
  2057.         (data-type (car parsed-args))
  2058.         (name (car (cdr  parsed-args)))
  2059.         (args (cdr (cdr parsed-args))))
  2060.     (insert " -- " category ": " data-type " " name)
  2061.     (while args
  2062.       (insert " " (car args))
  2063.       (setq args (cdr args)))))
  2064.  
  2065. ;; @defop: Generalized object-oriented
  2066. (put 'defop 'texinfo-deffn-formatting-property 'texinfo-format-defop)
  2067. (put 'defopx 'texinfo-deffn-formatting-property 'texinfo-format-defop)
  2068. (defun texinfo-format-defop (parsed-args)
  2069.   ;; Generalized object oriented entity: 
  2070.   ;; @defop category class name args...
  2071.   ;;     In Info, `Category on class: name ARG'
  2072.   ;; Note: args in upper case; use of `on'
  2073.   (let ((category (car parsed-args))
  2074.         (class (car (cdr parsed-args)))
  2075.         (name (car (cdr (cdr parsed-args))))
  2076.         (args (cdr (cdr (cdr parsed-args)))))
  2077.     (insert " -- " category " on " class ": " name)
  2078.     (while args
  2079.       (insert " " (upcase (car args)))
  2080.       (setq args (cdr args)))))
  2081.  
  2082. ;; @defcv: Generalized object-oriented
  2083. (put 'defcv 'texinfo-deffn-formatting-property 'texinfo-format-defcv)
  2084. (put 'defcvx 'texinfo-deffn-formatting-property 'texinfo-format-defcv)
  2085. (defun texinfo-format-defcv (parsed-args)
  2086.   ;; Generalized object oriented entity: 
  2087.   ;; @defcv category class name         
  2088.   ;;     In Info, `Category of class: name'
  2089.   ;; Note: args in upper case; use of `of'
  2090.   (let ((category (car parsed-args))
  2091.         (class (car (cdr parsed-args)))
  2092.         (name (car (cdr (cdr parsed-args))))
  2093.         (args (cdr (cdr (cdr parsed-args)))))
  2094.     (insert " -- " category " of " class ": " name)
  2095.     (while args
  2096.       (insert " " (upcase (car args)))
  2097.       (setq args (cdr args)))))
  2098.  
  2099. ;; @defmethod: Specialized object-oriented
  2100. (put 'defmethod 'texinfo-deffn-formatting-property 'texinfo-format-defmethod)
  2101. (put 'defmethodx 'texinfo-deffn-formatting-property 'texinfo-format-defmethod)
  2102. (defun texinfo-format-defmethod (parsed-args)
  2103.   ;; Specialized object oriented entity:
  2104.   ;; @defmethod class name args... 
  2105.   ;;     In Info, `Method on class: name ARGS'
  2106.   ;; Note: args in upper case; use of `on'
  2107.   ;; Use cdr of command-type to determine category:
  2108.   (let ((category (car (cdr command-type)))
  2109.         (class (car parsed-args))
  2110.         (name (car (cdr  parsed-args)))
  2111.         (args (cdr  (cdr parsed-args))))
  2112.     (insert " -- " category " on " class ": " name)
  2113.     (while args
  2114.       (insert " " (upcase (car args)))
  2115.       (setq args (cdr args)))))
  2116.  
  2117. ;; @defivar: Specialized object-oriented
  2118. (put 'defivar 'texinfo-deffn-formatting-property 'texinfo-format-defivar)
  2119. (put 'defivarx 'texinfo-deffn-formatting-property 'texinfo-format-defivar)
  2120. (defun texinfo-format-defivar (parsed-args)
  2121.   ;; Specialized object oriented entity:
  2122.   ;; @defivar class name
  2123.   ;;     In Info, `Instance variable of class: name'
  2124.   ;; Note: args in upper case; use of `of'
  2125.   ;; Use cdr of command-type to determine category:
  2126.   (let ((category (car (cdr command-type)))
  2127.         (class (car parsed-args))
  2128.         (name (car (cdr  parsed-args)))
  2129.         (args (cdr  (cdr parsed-args))))
  2130.     (insert " -- " category " of " class ": " name)
  2131.     (while args
  2132.       (insert " " (upcase (car args)))
  2133.       (setq args (cdr args)))))
  2134.  
  2135.  
  2136. ;;; Indexing for definitions
  2137.  
  2138. ;; An index entry has three parts: the `entry proper', the node name, and the
  2139. ;; line number.  Depending on the which command is used, the entry is
  2140. ;; formatted differently:
  2141. ;;
  2142. ;; @defun, 
  2143. ;; @defmac, 
  2144. ;; @defspec, 
  2145. ;; @defvar, 
  2146. ;; @defopt          all use their 1st argument as the entry-proper 
  2147. ;;
  2148. ;; @deffn, 
  2149. ;; @defvr, 
  2150. ;; @deftp 
  2151. ;; @deftypefun
  2152. ;; @deftypevar      all use their 2nd argument as the entry-proper
  2153. ;;
  2154. ;; @deftypefn, 
  2155. ;; @deftypevr       both use their 3rd argument as the entry-proper  
  2156. ;;
  2157. ;; @defmethod       uses its 2nd and 1st arguments as an entry-proper 
  2158. ;;                    formatted: NAME on CLASS
  2159.  
  2160. ;; @defop           uses its 3rd and 2nd arguments as an entry-proper 
  2161. ;;                    formatted: NAME on CLASS
  2162. ;;        
  2163. ;; @defivar         uses its 2nd and 1st arguments as an entry-proper
  2164. ;;                    formatted: NAME of CLASS
  2165. ;;
  2166. ;; @defcv           uses its 3rd and 2nd argument as an entry-proper
  2167. ;;                    formatted: NAME of CLASS
  2168.  
  2169. (put 'defun 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2170. (put 'defunx 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2171. (put 'defmac 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2172. (put 'defmacx 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2173. (put 'defspec 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2174. (put 'defspecx 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2175. (put 'defvar 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2176. (put 'defvarx 'texinfo-defun-indexing-property 'texinfo-index-defun)
  2177. (put 'defopt  'texinfo-defun-indexing-property 'texinfo-index-defun)
  2178. (put 'defoptx  'texinfo-defun-indexing-property 'texinfo-index-defun)
  2179. (defun texinfo-index-defun (parsed-args)
  2180.   ;; use 1st parsed-arg  as entry-proper
  2181.   ;; `index-list' will be texinfo-findex or the like
  2182.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2183.     (set index-list
  2184.          (cons 
  2185.           ;; Three elements: entry-proper, node-name, line-number
  2186.           (list
  2187.            (car parsed-args)
  2188.            texinfo-last-node
  2189.            ;; Region formatting may not provide last node position.
  2190.            (if texinfo-last-node-pos
  2191.                (1+ (count-lines texinfo-last-node-pos (point)))
  2192.              1))
  2193.           (symbol-value index-list)))))
  2194.  
  2195. (put 'deffn 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2196. (put 'deffnx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2197. (put 'defvr 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2198. (put 'defvrx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2199. (put 'deftp 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2200. (put 'deftpx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2201. (put 'deftypefun 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2202. (put 'deftypefunx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2203. (put 'deftypevar 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2204. (put 'deftypevarx 'texinfo-defun-indexing-property 'texinfo-index-deffn)
  2205. (defun texinfo-index-deffn (parsed-args) 
  2206.  ;; use 2nd parsed-arg  as entry-proper
  2207.   ;; `index-list' will be texinfo-findex or the like
  2208.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2209.     (set index-list
  2210.          (cons 
  2211.           ;; Three elements: entry-proper, node-name, line-number
  2212.           (list
  2213.            (car (cdr parsed-args))
  2214.            texinfo-last-node
  2215.            ;; Region formatting may not provide last node position.
  2216.            (if texinfo-last-node-pos
  2217.                (1+ (count-lines texinfo-last-node-pos (point)))
  2218.              1))
  2219.           (symbol-value index-list)))))
  2220.  
  2221. (put 'deftypefn 'texinfo-defun-indexing-property 'texinfo-index-deftypefn)
  2222. (put 'deftypefnx 'texinfo-defun-indexing-property 'texinfo-index-deftypefn)
  2223. (put 'deftypevr 'texinfo-defun-indexing-property 'texinfo-index-deftypefn)
  2224. (put 'deftypevrx 'texinfo-defun-indexing-property 'texinfo-index-deftypefn)
  2225. (defun texinfo-index-deftypefn (parsed-args)
  2226.   ;; use 3rd parsed-arg  as entry-proper
  2227.   ;; `index-list' will be texinfo-findex or the like
  2228.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2229.     (set index-list
  2230.          (cons 
  2231.           ;; Three elements: entry-proper, node-name, line-number
  2232.           (list
  2233.            (car (cdr (cdr parsed-args)))
  2234.            texinfo-last-node
  2235.            ;; Region formatting may not provide last node position.
  2236.            (if texinfo-last-node-pos
  2237.                (1+ (count-lines texinfo-last-node-pos (point)))
  2238.              1))
  2239.           (symbol-value index-list)))))
  2240.  
  2241. (put 'defmethod 'texinfo-defun-indexing-property 'texinfo-index-defmethod)
  2242. (put 'defmethodx 'texinfo-defun-indexing-property 'texinfo-index-defmethod)
  2243. (defun texinfo-index-defmethod (parsed-args)
  2244.   ;; use 2nd on 1st parsed-arg  as entry-proper
  2245.   ;; `index-list' will be texinfo-findex or the like
  2246.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2247.     (set index-list
  2248.          (cons 
  2249.           ;; Three elements: entry-proper, node-name, line-number
  2250.           (list
  2251.            (format "%s on %s"            
  2252.                    (car (cdr parsed-args))
  2253.                    (car parsed-args))
  2254.            texinfo-last-node
  2255.            ;; Region formatting may not provide last node position.
  2256.            (if texinfo-last-node-pos
  2257.                (1+ (count-lines texinfo-last-node-pos (point)))
  2258.              1))
  2259.           (symbol-value index-list)))))
  2260.  
  2261. (put 'defop 'texinfo-defun-indexing-property 'texinfo-index-defop)
  2262. (put 'defopx 'texinfo-defun-indexing-property 'texinfo-index-defop)
  2263. (defun texinfo-index-defop (parsed-args)
  2264.   ;; use 3rd on 2nd parsed-arg  as entry-proper
  2265.   ;; `index-list' will be texinfo-findex or the like
  2266.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2267.     (set index-list
  2268.          (cons 
  2269.           ;; Three elements: entry-proper, node-name, line-number
  2270.           (list
  2271.            (format "%s on %s"            
  2272.                    (car (cdr (cdr parsed-args)))
  2273.                    (car (cdr parsed-args)))
  2274.            texinfo-last-node
  2275.            ;; Region formatting may not provide last node position.
  2276.            (if texinfo-last-node-pos
  2277.                (1+ (count-lines texinfo-last-node-pos (point)))
  2278.              1))
  2279.           (symbol-value index-list)))))
  2280.  
  2281. (put 'defivar 'texinfo-defun-indexing-property 'texinfo-index-defivar)
  2282. (put 'defivarx 'texinfo-defun-indexing-property 'texinfo-index-defivar)
  2283. (defun texinfo-index-defivar (parsed-args)
  2284.   ;; use 2nd of 1st parsed-arg  as entry-proper
  2285.   ;; `index-list' will be texinfo-findex or the like
  2286.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2287.     (set index-list
  2288.          (cons 
  2289.           ;; Three elements: entry-proper, node-name, line-number
  2290.           (list
  2291.            (format "%s of %s"            
  2292.                    (car (cdr parsed-args))
  2293.                    (car parsed-args))
  2294.            texinfo-last-node
  2295.            ;; Region formatting may not provide last node position.
  2296.            (if texinfo-last-node-pos
  2297.                (1+ (count-lines texinfo-last-node-pos (point)))
  2298.              1))
  2299.           (symbol-value index-list)))))
  2300.  
  2301. (put 'defcv 'texinfo-defun-indexing-property 'texinfo-index-defcv)
  2302. (put 'defcvx 'texinfo-defun-indexing-property 'texinfo-index-defcv)
  2303. (defun texinfo-index-defcv (parsed-args)
  2304.   ;; use 3rd of 2nd parsed-arg  as entry-proper
  2305.   ;; `index-list' will be texinfo-findex or the like
  2306.   (let ((index-list (get texinfo-command-name 'texinfo-defun-index)))
  2307.     (set index-list
  2308.          (cons 
  2309.           ;; Three elements: entry-proper, node-name, line-number
  2310.           (list
  2311.            (format "%s of %s"            
  2312.                    (car (cdr (cdr parsed-args)))
  2313.                    (car (cdr parsed-args)))
  2314.            texinfo-last-node
  2315.            ;; Region formatting may not provide last node position.
  2316.            (if texinfo-last-node-pos
  2317.                (1+ (count-lines texinfo-last-node-pos (point)))
  2318.              1))
  2319.           (symbol-value index-list)))))
  2320.  
  2321.  
  2322. ;;; Properties for definitions
  2323.  
  2324. ;; Each definition command has six properties:
  2325. ;;
  2326. ;; 1. texinfo-deffn-formatting-property      to format definition line
  2327. ;; 2. texinfo-defun-indexing-property        to create index entry
  2328. ;; 3. texinfo-format                         formatting command
  2329. ;; 4. texinfo-end                            end formatting command
  2330. ;; 5. texinfo-defun-type                     type of deffn to format
  2331. ;; 6. texinfo-defun-index                    type of index to use
  2332. ;;
  2333. ;; The `x' forms of each definition command are used for the second
  2334. ;; and subsequent header lines.
  2335.  
  2336. ;; The texinfo-deffn-formatting-property and texinfo-defun-indexing-property
  2337. ;; are listed just before the appropriate formatting and indexing commands.
  2338.  
  2339. (put 'deffn 'texinfo-format 'texinfo-format-defun)
  2340. (put 'deffnx 'texinfo-format 'texinfo-format-defunx)
  2341. (put 'deffn 'texinfo-end 'texinfo-end-defun)
  2342. (put 'deffn 'texinfo-defun-type '('deffn-type nil))
  2343. (put 'deffnx 'texinfo-defun-type '('deffn-type nil))
  2344. (put 'deffn 'texinfo-defun-index 'texinfo-findex)
  2345. (put 'deffnx 'texinfo-defun-index 'texinfo-findex)
  2346.  
  2347. (put 'defun 'texinfo-format 'texinfo-format-defun)
  2348. (put 'defunx 'texinfo-format 'texinfo-format-defunx)
  2349. (put 'defun 'texinfo-end 'texinfo-end-defun)
  2350. (put 'defun 'texinfo-defun-type '('defun-type "Function"))
  2351. (put 'defunx 'texinfo-defun-type '('defun-type "Function"))
  2352. (put 'defun 'texinfo-defun-index 'texinfo-findex)
  2353. (put 'defunx 'texinfo-defun-index 'texinfo-findex)
  2354.  
  2355. (put 'defmac 'texinfo-format 'texinfo-format-defun)
  2356. (put 'defmacx 'texinfo-format 'texinfo-format-defunx)
  2357. (put 'defmac 'texinfo-end 'texinfo-end-defun)
  2358. (put 'defmac 'texinfo-defun-type '('defun-type "Macro"))
  2359. (put 'defmacx 'texinfo-defun-type '('defun-type "Macro"))
  2360. (put 'defmac 'texinfo-defun-index 'texinfo-findex)
  2361. (put 'defmacx 'texinfo-defun-index 'texinfo-findex)
  2362.  
  2363. (put 'defspec 'texinfo-format 'texinfo-format-defun)
  2364. (put 'defspecx 'texinfo-format 'texinfo-format-defunx)
  2365. (put 'defspec 'texinfo-end 'texinfo-end-defun)
  2366. (put 'defspec 'texinfo-defun-type '('defun-type "Special form"))
  2367. (put 'defspecx 'texinfo-defun-type '('defun-type "Special form"))
  2368. (put 'defspec 'texinfo-defun-index 'texinfo-findex)
  2369. (put 'defspecx 'texinfo-defun-index 'texinfo-findex)
  2370.  
  2371. (put 'defvr 'texinfo-format 'texinfo-format-defun)
  2372. (put 'defvrx 'texinfo-format 'texinfo-format-defunx)
  2373. (put 'defvr 'texinfo-end 'texinfo-end-defun)
  2374. (put 'defvr 'texinfo-defun-type '('deffn-type nil))
  2375. (put 'defvrx 'texinfo-defun-type '('deffn-type nil))
  2376. (put 'defvr 'texinfo-defun-index 'texinfo-vindex)
  2377. (put 'defvrx 'texinfo-defun-index 'texinfo-vindex)
  2378.  
  2379. (put 'defvar 'texinfo-format 'texinfo-format-defun)
  2380. (put 'defvarx 'texinfo-format 'texinfo-format-defunx)
  2381. (put 'defvar 'texinfo-end 'texinfo-end-defun)
  2382. (put 'defvar 'texinfo-defun-type '('defun-type "Variable"))
  2383. (put 'defvarx 'texinfo-defun-type '('defun-type "Variable"))
  2384. (put 'defvar 'texinfo-defun-index 'texinfo-vindex)
  2385. (put 'defvarx 'texinfo-defun-index 'texinfo-vindex)
  2386.  
  2387. (put 'defconst 'texinfo-format 'texinfo-format-defun)
  2388. (put 'defconstx 'texinfo-format 'texinfo-format-defunx)
  2389. (put 'defconst 'texinfo-end 'texinfo-end-defun)
  2390. (put 'defconst 'texinfo-defun-type '('defun-type "Constant"))
  2391. (put 'defconstx 'texinfo-defun-type '('defun-type "Constant"))
  2392. (put 'defconst 'texinfo-defun-index 'texinfo-vindex)
  2393. (put 'defconstx 'texinfo-defun-index 'texinfo-vindex)
  2394.  
  2395. (put 'defcmd 'texinfo-format 'texinfo-format-defun)
  2396. (put 'defcmdx 'texinfo-format 'texinfo-format-defunx)
  2397. (put 'defcmd 'texinfo-end 'texinfo-end-defun)
  2398. (put 'defcmd 'texinfo-defun-type '('defun-type "Command"))
  2399. (put 'defcmdx 'texinfo-defun-type '('defun-type "Command"))
  2400. (put 'defcmd 'texinfo-defun-index 'texinfo-findex)
  2401. (put 'defcmdx 'texinfo-defun-index 'texinfo-findex)
  2402.  
  2403. (put 'defopt 'texinfo-format 'texinfo-format-defun)
  2404. (put 'defoptx 'texinfo-format 'texinfo-format-defunx)
  2405. (put 'defopt 'texinfo-end 'texinfo-end-defun)
  2406. (put 'defopt 'texinfo-defun-type '('defun-type "User Option"))
  2407. (put 'defoptx 'texinfo-defun-type '('defun-type "User Option"))
  2408. (put 'defopt 'texinfo-defun-index 'texinfo-vindex)
  2409. (put 'defoptx 'texinfo-defun-index 'texinfo-vindex)
  2410.  
  2411. (put 'deftp 'texinfo-format 'texinfo-format-defun)
  2412. (put 'deftpx 'texinfo-format 'texinfo-format-defunx)
  2413. (put 'deftp 'texinfo-end 'texinfo-end-defun)
  2414. (put 'deftp 'texinfo-defun-type '('deftp-type nil))
  2415. (put 'deftpx 'texinfo-defun-type '('deftp-type nil))
  2416. (put 'deftp 'texinfo-defun-index 'texinfo-tindex)
  2417. (put 'deftpx 'texinfo-defun-index 'texinfo-tindex)
  2418.  
  2419. ;;; Object-oriented stuff is a little hairier.
  2420.  
  2421. (put 'defop 'texinfo-format 'texinfo-format-defun)
  2422. (put 'defopx 'texinfo-format 'texinfo-format-defunx)
  2423. (put 'defop 'texinfo-end 'texinfo-end-defun)
  2424. (put 'defop 'texinfo-defun-type '('defop-type nil))
  2425. (put 'defopx 'texinfo-defun-type '('defop-type nil))
  2426. (put 'defop 'texinfo-defun-index 'texinfo-findex)
  2427. (put 'defopx 'texinfo-defun-index 'texinfo-findex)
  2428.  
  2429. (put 'defmethod 'texinfo-format 'texinfo-format-defun)
  2430. (put 'defmethodx 'texinfo-format 'texinfo-format-defunx)
  2431. (put 'defmethod 'texinfo-end 'texinfo-end-defun)
  2432. (put 'defmethod 'texinfo-defun-type '('defmethod-type "Method"))
  2433. (put 'defmethodx 'texinfo-defun-type '('defmethod-type "Method"))
  2434. (put 'defmethod 'texinfo-defun-index 'texinfo-findex)
  2435. (put 'defmethodx 'texinfo-defun-index 'texinfo-findex)
  2436.  
  2437. (put 'defcv 'texinfo-format 'texinfo-format-defun)
  2438. (put 'defcvx 'texinfo-format 'texinfo-format-defunx)
  2439. (put 'defcv 'texinfo-end 'texinfo-end-defun)
  2440. (put 'defcv 'texinfo-defun-type '('defop-type nil))
  2441. (put 'defcvx 'texinfo-defun-type '('defop-type nil))
  2442. (put 'defcv 'texinfo-defun-index 'texinfo-vindex)
  2443. (put 'defcvx 'texinfo-defun-index 'texinfo-vindex)
  2444.  
  2445. (put 'defivar 'texinfo-format 'texinfo-format-defun)
  2446. (put 'defivarx 'texinfo-format 'texinfo-format-defunx)
  2447. (put 'defivar 'texinfo-end 'texinfo-end-defun)
  2448. (put 'defivar 'texinfo-defun-type '('defmethod-type "Instance variable"))
  2449. (put 'defivarx 'texinfo-defun-type '('defmethod-type "Instance variable"))
  2450. (put 'defivar 'texinfo-defun-index 'texinfo-vindex)
  2451. (put 'defivarx 'texinfo-defun-index 'texinfo-vindex)
  2452.  
  2453. ;;; Typed functions and variables
  2454.  
  2455. (put 'deftypefn 'texinfo-format 'texinfo-format-defun)
  2456. (put 'deftypefnx 'texinfo-format 'texinfo-format-defunx)
  2457. (put 'deftypefn 'texinfo-end 'texinfo-end-defun)
  2458. (put 'deftypefn 'texinfo-defun-type '('deftypefn-type nil))
  2459. (put 'deftypefnx 'texinfo-defun-type '('deftypefn-type nil))
  2460. (put 'deftypefn 'texinfo-defun-index 'texinfo-findex)
  2461. (put 'deftypefnx 'texinfo-defun-index 'texinfo-findex)
  2462.  
  2463. (put 'deftypefun 'texinfo-format 'texinfo-format-defun)
  2464. (put 'deftypefunx 'texinfo-format 'texinfo-format-defunx)
  2465. (put 'deftypefun 'texinfo-end 'texinfo-end-defun)
  2466. (put 'deftypefun 'texinfo-defun-type '('deftypefun-type "Function"))
  2467. (put 'deftypefunx 'texinfo-defun-type '('deftypefun-type "Function"))
  2468. (put 'deftypefun 'texinfo-defun-index 'texinfo-findex)
  2469. (put 'deftypefunx 'texinfo-defun-index 'texinfo-findex)
  2470.  
  2471. (put 'deftypevr 'texinfo-format 'texinfo-format-defun)
  2472. (put 'deftypevrx 'texinfo-format 'texinfo-format-defunx)
  2473. (put 'deftypevr 'texinfo-end 'texinfo-end-defun)
  2474. (put 'deftypevr 'texinfo-defun-type '('deftypefn-type nil))
  2475. (put 'deftypevrx 'texinfo-defun-type '('deftypefn-type nil))
  2476. (put 'deftypevr 'texinfo-defun-index 'texinfo-vindex)
  2477. (put 'deftypevrx 'texinfo-defun-index 'texinfo-vindex)
  2478.  
  2479. (put 'deftypevar 'texinfo-format 'texinfo-format-defun)
  2480. (put 'deftypevarx 'texinfo-format 'texinfo-format-defunx)
  2481. (put 'deftypevar 'texinfo-end 'texinfo-end-defun)
  2482. (put 'deftypevar 'texinfo-defun-type '('deftypevar-type "Variable"))
  2483. (put 'deftypevarx 'texinfo-defun-type '('deftypevar-type "Variable"))
  2484. (put 'deftypevar 'texinfo-defun-index 'texinfo-vindex)
  2485. (put 'deftypevarx 'texinfo-defun-index 'texinfo-vindex)
  2486.  
  2487.  
  2488. ;;; @set, @clear, @ifset, @ifclear
  2489.  
  2490. ;; If a flag is set with @set FLAG, then text between @ifset and @end
  2491. ;; ifset is formatted normally, but if the flag is is cleared with
  2492. ;; @clear FLAG, then the text is not formatted; it is ignored.
  2493.  
  2494. ;; If a flag is cleared with @clear FLAG, then text between @ifclear
  2495. ;; and @end ifclear is formatted normally, but if the flag is is set with
  2496. ;; @set FLAG, then the text is not formatted; it is ignored.  @ifclear
  2497. ;; is the opposite of @ifset.
  2498.  
  2499. ;; If a flag is set to a string with @set FLAG, 
  2500. ;; replace  @value{FLAG} with the string.
  2501. ;; If a flag with a value is cleared, 
  2502. ;; @value{FLAG} is invalid, 
  2503. ;; as if there had never been any @set FLAG previously.
  2504.  
  2505. (put 'clear 'texinfo-format 'texinfo-clear)
  2506. (defun texinfo-clear ()
  2507.   "Clear the value of the flag."
  2508.   (let* ((arg (texinfo-parse-arg-discard))
  2509.          (flag (car (read-from-string arg)))
  2510.          (value (substring arg (cdr (read-from-string arg)))))
  2511.     (put flag 'texinfo-whether-setp 'flag-cleared)
  2512.     (put flag 'texinfo-set-value "")))
  2513.  
  2514. (put 'set 'texinfo-format 'texinfo-set)
  2515. (defun texinfo-set ()
  2516.   "Set the value of the flag, optionally to a string.
  2517. The command  `@set foo This is a string.'
  2518. sets flag foo to the value: `This is a string.'
  2519. The command  `@value{foo}'  expands to the value."
  2520.   (let* ((arg (texinfo-parse-arg-discard))
  2521.          (flag (car (read-from-string arg)))
  2522.          (value (substring arg (cdr (read-from-string arg)))))
  2523.     (put flag 'texinfo-whether-setp 'flag-set)
  2524.     (put flag 'texinfo-set-value value)))
  2525.  
  2526. (put 'value 'texinfo-format 'texinfo-value)
  2527. (defun texinfo-value ()
  2528.   "Insert the string to which the flag is set.
  2529. The command  `@set foo This is a string.'
  2530. sets flag foo to the value: `This is a string.'
  2531. The command  `@value{foo}'  expands to the value."
  2532.   (let ((arg (texinfo-parse-arg-discard)))
  2533.     (cond ((and
  2534.             (eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2535.                 'flag-set)
  2536.             (get (car (read-from-string arg)) 'texinfo-set-value))
  2537.            (insert (get (car (read-from-string arg)) 'texinfo-set-value)))
  2538.           ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp) 
  2539.                'flag-cleared)
  2540.            (insert (format "{No value for \"%s\"}"  arg)))
  2541.           ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp) nil)
  2542.            (insert (format "{No value for \"%s\"}"  arg))))))
  2543.  
  2544. (put 'ifset 'texinfo-end 'texinfo-discard-command)
  2545. (put 'ifset 'texinfo-format 'texinfo-if-set)
  2546. (defun texinfo-if-set ()
  2547.   "If set, continue formatting; else do not format region up to @end ifset"
  2548.   (let ((arg (texinfo-parse-arg-discard)))
  2549.     (cond
  2550.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2551.           'flag-set)
  2552.       ;; Format the text (i.e., do not remove it); do nothing here.
  2553.       ())
  2554.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2555.           'flag-cleared)
  2556.       ;; Clear region (i.e., cause the text to be ignored).
  2557.       (delete-region texinfo-command-start
  2558.                        (progn (re-search-forward "@end ifset[ \t]*\n")
  2559.                               (point))))
  2560.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2561.           nil)
  2562.       (error  "@ifset flag `%s' is not defined by @set or @clear." arg)))))
  2563.  
  2564. (put 'ifclear 'texinfo-end 'texinfo-discard-command)
  2565. (put 'ifclear 'texinfo-format 'texinfo-if-clear)
  2566. (defun texinfo-if-clear ()
  2567.   "If clear, continue formatting; if set, do not format up to @end ifset"
  2568.   (let ((arg (texinfo-parse-arg-discard)))
  2569.     (cond
  2570.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2571.           'flag-set)
  2572.       ;; Clear region (i.e., cause the text to be ignored).
  2573.       (delete-region texinfo-command-start
  2574.                        (progn (re-search-forward "@end ifclear[ \t]*\n")
  2575.                               (point))))
  2576.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2577.           'flag-cleared)
  2578.       ;; Format the text (i.e., do not remove it); do nothing here.
  2579.       ())
  2580.      ((eq (get (car (read-from-string arg)) 'texinfo-whether-setp)
  2581.           nil)
  2582.       (error  "@ifclear flag `%s' is not defined by @clear or @set." arg)))))
  2583.  
  2584.  
  2585. ;;; Process included files:  `@include' command
  2586.  
  2587. ;; Updated 19 October 1990
  2588. ;; In the original version, include files were ignored by Info but
  2589. ;; incorporated in to the printed manual.  To make references to the
  2590. ;; included file, the Texinfo source file has to refer to the included
  2591. ;; files using the `(filename)nodename' format for refering to other
  2592. ;; Info files.  Also, the included files had to be formatted on their
  2593. ;; own.  It was just like they were another file.
  2594.  
  2595. ;; Currently, include files are inserted into the buffer that is
  2596. ;; formatted for Info.  If large, the resulting info file is split and
  2597. ;; tagified.  For current include files to work, the master menu must
  2598. ;; refer to all the nodes, and the highest level nodes in the include
  2599. ;; files must have the correct next, prev, and up pointers.
  2600.  
  2601. ;; The included file may have an @setfilename and even an @settitle,
  2602. ;; but not an /input texinfo
  2603.  
  2604. ; Original definition:
  2605. ; (defun texinfo-format-include ()
  2606. ;   (let ((filename (texinfo-parse-arg-discard))
  2607. ;     (default-directory input-directory)
  2608. ;     subindex)
  2609. ;     (setq subindex
  2610. ;       (save-excursion
  2611. ;         (progn (find-file
  2612. ;             (cond ((file-readable-p (concat filename ".texinfo"))
  2613. ;                (concat filename ".texinfo"))
  2614. ;               ((file-readable-p (concat filename ".texi"))
  2615. ;                (concat filename ".texi"))
  2616. ;               ((file-readable-p (concat filename ".tex"))
  2617. ;                (concat filename ".tex"))
  2618. ;               ((file-readable-p filename)
  2619. ;                filename)
  2620. ;               (t (error "@include'd file %s not found"
  2621. ;                     filename))))
  2622. ;            (texinfo-format-buffer-1))))
  2623. ;     (texinfo-subindex 'texinfo-vindex (car subindex) (nth 1 subindex))
  2624. ;     (texinfo-subindex 'texinfo-findex (car subindex) (nth 2 subindex))
  2625. ;     (texinfo-subindex 'texinfo-cindex (car subindex) (nth 3 subindex))
  2626. ;     (texinfo-subindex 'texinfo-pindex (car subindex) (nth 4 subindex))
  2627. ;     (texinfo-subindex 'texinfo-tindex (car subindex) (nth 5 subindex))
  2628. ;     (texinfo-subindex 'texinfo-kindex (car subindex) (nth 6 subindex))))
  2629.  
  2630. (defun texinfo-subindex (indexvar file content)
  2631.   (set indexvar (cons (list 'recurse file content)
  2632.               (symbol-value indexvar))))
  2633.  
  2634. (put 'include 'texinfo-format 'texinfo-format-include)
  2635. (defun texinfo-format-include ()
  2636.   (let ((filename (concat input-directory
  2637.               (texinfo-parse-arg-discard)))
  2638.     (default-directory input-directory))
  2639.     (message "Reading: %s" filename)
  2640.     (save-excursion
  2641.       (save-restriction
  2642.         (narrow-to-region
  2643.          (point)
  2644.          (+ (point) (car (cdr (insert-file-contents filename)))))
  2645.         (goto-char (point-min))
  2646.         (texinfo-append-refill)
  2647.         (texinfo-format-convert (point-min) (point-max))))
  2648.     (setq last-input-buffer input-buffer)  ; to bypass setfilename
  2649.     ))
  2650.  
  2651.  
  2652. ;;; Numerous commands do nothing in Texinfo
  2653.  
  2654. ;; These commands are defined in texinfo.tex for printed output.
  2655.  
  2656. (put 'bye 'texinfo-format 'texinfo-discard-line)
  2657. (put 'c 'texinfo-format 'texinfo-discard-line-with-args)
  2658. (put 'comment 'texinfo-format 'texinfo-discard-line-with-args)
  2659. (put 'contents 'texinfo-format 'texinfo-discard-line-with-args)
  2660. (put 'finalout 'texinfo-format 'texinfo-discard-line)
  2661. (put 'group 'texinfo-end 'texinfo-discard-line-with-args)
  2662. (put 'group 'texinfo-format 'texinfo-discard-line-with-args)
  2663. (put 'headings 'texinfo-format 'texinfo-discard-line-with-args)
  2664. (put 'hsize 'texinfo-format 'texinfo-discard-line-with-args)
  2665. (put 'itemindent 'texinfo-format 'texinfo-discard-line-with-args)
  2666. (put 'lispnarrowing 'texinfo-format 'texinfo-discard-line-with-args)
  2667. (put 'need 'texinfo-format 'texinfo-discard-line-with-args)
  2668. (put 'nopara 'texinfo-format 'texinfo-discard-line-with-args)
  2669. (put 'page 'texinfo-format 'texinfo-discard-line-with-args)
  2670. (put 'parindent 'texinfo-format 'texinfo-discard-line-with-args)
  2671. (put 'setchapternewpage 'texinfo-format 'texinfo-discard-line-with-args)
  2672. (put 'setq 'texinfo-format 'texinfo-discard-line-with-args)
  2673. (put 'settitle 'texinfo-format 'texinfo-discard-line-with-args)
  2674. (put 'setx 'texinfo-format 'texinfo-discard-line-with-args)
  2675. (put 'shortcontents 'texinfo-format 'texinfo-discard-line-with-args)
  2676. (put 'smallbook 'texinfo-format 'texinfo-discard-line)
  2677. (put 'summarycontents 'texinfo-format 'texinfo-discard-line-with-args)
  2678.  
  2679.  
  2680. ;;; Some commands cannot be handled
  2681.  
  2682. (defun texinfo-unsupported ()
  2683.   (error "%s is not handled by texinfo"
  2684.      (buffer-substring texinfo-command-start texinfo-command-end)))
  2685.  
  2686. ;;; Batch formatting
  2687.  
  2688. (defun batch-texinfo-format ()
  2689.   "Runs  texinfo-format-buffer  on the files remaining on the command line.
  2690. Must be used only with -batch, and kills emacs on completion.
  2691. Each file will be processed even if an error occurred previously.
  2692. For example, invoke
  2693.   \"emacs -batch -funcall batch-texinfo-format $docs/ ~/*.texinfo\"."
  2694.   (if (not noninteractive)
  2695.       (error "batch-texinfo-format may only be used -batch."))
  2696.   (let ((version-control t)
  2697.     (auto-save-default nil)
  2698.     (find-file-run-dired nil)
  2699.     (kept-old-versions 259259)
  2700.     (kept-new-versions 259259))
  2701.     (let ((error 0)
  2702.       file
  2703.       (files ()))
  2704.       (while command-line-args-left
  2705.     (setq file (expand-file-name (car command-line-args-left)))
  2706.     (cond ((not (file-exists-p file))
  2707.            (message ">> %s does not exist!" file)
  2708.            (setq error 1
  2709.              command-line-args-left (cdr command-line-args-left)))
  2710.           ((file-directory-p file)
  2711.            (setq command-line-args-left
  2712.              (nconc (directory-files file)
  2713.                 (cdr command-line-args-left))))
  2714.           (t
  2715.            (setq files (cons file files)
  2716.              command-line-args-left (cdr command-line-args-left)))))
  2717.       (while files
  2718.     (setq file (car files)
  2719.           files (cdr files))
  2720.     (condition-case err
  2721.         (progn
  2722.           (if buffer-file-name (kill-buffer (current-buffer)))
  2723.           (find-file file)
  2724.           (buffer-flush-undo (current-buffer))
  2725.           (set-buffer-modified-p nil)
  2726.           (texinfo-mode)
  2727.           (message "texinfo formatting %s..." file)
  2728.           (texinfo-format-buffer nil)
  2729.           (if (buffer-modified-p)
  2730.           (progn (message "Saving modified %s" (buffer-file-name))
  2731.              (save-buffer))))
  2732.       (error
  2733.        (message ">> Error: %s" (prin1-to-string err))
  2734.        (message ">>  point at")
  2735.        (let ((s (buffer-substring (point)
  2736.                       (min (+ (point) 100)
  2737.                        (point-max))))
  2738.          (tem 0))
  2739.          (while (setq tem (string-match "\n+" s tem))
  2740.            (setq s (concat (substring s 0 (match-beginning 0))
  2741.                    "\n>>  "
  2742.                    (substring s (match-end 0)))
  2743.              tem (1+ tem)))
  2744.          (message ">>  %s" s))
  2745.        (setq error 1))))
  2746.       (kill-emacs error))))
  2747.  
  2748.  
  2749. ;;; Place `provide' at end of file.
  2750. (provide 'texinfmt)
  2751. ;;;;;;;;;;;;;;;; end texinfmt.el ;;;;;;;;;;;;;;;;
  2752.